REST API for Raportado Services

EsmaesefRestController

deleteReportUsingDELETE

Delete ESEF report from REST collection


/esma-esef/reports/{id}

Usage and SDK Samples

curl -X DELETE "https://localhost:8088/raportado-services/esma-esef/reports/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EsmaesefRestControllerApi;

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

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            apiInstance.deleteReportUsingDELETE(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#deleteReportUsingDELETE");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EsmaesefRestControllerApi;

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            apiInstance.deleteReportUsingDELETE(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#deleteReportUsingDELETE");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Delete ESEF report from REST collection
[apiInstance deleteReportUsingDELETEWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.EsmaesefRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class deleteReportUsingDELETEExample
    {
        public void main()
        {
            
            var apiInstance = new EsmaesefRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Delete ESEF report from REST collection
                apiInstance.deleteReportUsingDELETE(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EsmaesefRestControllerApi.deleteReportUsingDELETE: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EsmaesefRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::EsmaesefRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    $api_instance->deleteReportUsingDELETE(id => $id);
};
if ($@) {
    warn "Exception when calling EsmaesefRestControllerApi->deleteReportUsingDELETE: $@\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.EsmaesefRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Delete ESEF report from REST collection
    api_instance.delete_report_using_delete(id)
except ApiException as e:
    print("Exception when calling EsmaesefRestControllerApi->deleteReportUsingDELETE: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 204 - No Content

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist


exportCSVUsingGET

Export ESEF report data to CSV document


/esma-esef/reports/{id}/export-to-csv

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/esma-esef/reports/{id}/export-to-csv"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EsmaesefRestControllerApi;

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

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.exportCSVUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#exportCSVUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EsmaesefRestControllerApi;

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.exportCSVUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#exportCSVUsingGET");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Export ESEF report data to CSV document
[apiInstance exportCSVUsingGETWith:id
              completionHandler: ^(Resource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.EsmaesefRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class exportCSVUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new EsmaesefRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Export ESEF report data to CSV document
                Resource result = apiInstance.exportCSVUsingGET(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EsmaesefRestControllerApi.exportCSVUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EsmaesefRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::EsmaesefRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    my $result = $api_instance->exportCSVUsingGET(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EsmaesefRestControllerApi->exportCSVUsingGET: $@\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.EsmaesefRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Export ESEF report data to CSV document
    api_response = api_instance.export_csv_using_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EsmaesefRestControllerApi->exportCSVUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


exportJSONUsingGET

Export ESEF report data to JSON document


/esma-esef/reports/{id}/export-to-json

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/esma-esef/reports/{id}/export-to-json"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EsmaesefRestControllerApi;

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

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.exportJSONUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#exportJSONUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EsmaesefRestControllerApi;

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.exportJSONUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#exportJSONUsingGET");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Export ESEF report data to JSON document
[apiInstance exportJSONUsingGETWith:id
              completionHandler: ^(Resource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.EsmaesefRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class exportJSONUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new EsmaesefRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Export ESEF report data to JSON document
                Resource result = apiInstance.exportJSONUsingGET(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EsmaesefRestControllerApi.exportJSONUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EsmaesefRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::EsmaesefRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    my $result = $api_instance->exportJSONUsingGET(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EsmaesefRestControllerApi->exportJSONUsingGET: $@\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.EsmaesefRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Export ESEF report data to JSON document
    api_response = api_instance.export_json_using_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EsmaesefRestControllerApi->exportJSONUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


exportValidationResultsToExcelUsingGET

Export ESEF report validation results to Excel document


/esma-esef/reports/{id}/validation-results-excel

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/esma-esef/reports/{id}/validation-results-excel?excludedAssertions=&excludedFilingRules=&validateDimensions=&validateFilingRules=&validateFormulas=&validateInlineXBRL=&validateTaxonomy=&validateXBRL="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EsmaesefRestControllerApi;

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

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Long id = 789; // Long | Report ID
        String excludedAssertions = excludedAssertions_example; // String | List of Formula assertion IDs to be excluded
        String excludedFilingRules = excludedFilingRules_example; // String | List of filing rules IDs to be excluded
        Boolean validateDimensions = true; // Boolean | Switch ON/OFF dimensions validation
        Boolean validateFilingRules = true; // Boolean | Switch ON/OFF filing rules validation
        Boolean validateFormulas = true; // Boolean | Switch ON/OFF formula validation
        Boolean validateInlineXBRL = true; // Boolean | Switch ON/OFF Inline XBRL validation
        Boolean validateTaxonomy = true; // Boolean | Switch ON/OFF taxonomy validation
        Boolean validateXBRL = true; // Boolean | Switch ON/OFF XBRL 2.1 validation
        try {
            Resource result = apiInstance.exportValidationResultsToExcelUsingGET(id, excludedAssertions, excludedFilingRules, validateDimensions, validateFilingRules, validateFormulas, validateInlineXBRL, validateTaxonomy, validateXBRL);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#exportValidationResultsToExcelUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EsmaesefRestControllerApi;

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Long id = 789; // Long | Report ID
        String excludedAssertions = excludedAssertions_example; // String | List of Formula assertion IDs to be excluded
        String excludedFilingRules = excludedFilingRules_example; // String | List of filing rules IDs to be excluded
        Boolean validateDimensions = true; // Boolean | Switch ON/OFF dimensions validation
        Boolean validateFilingRules = true; // Boolean | Switch ON/OFF filing rules validation
        Boolean validateFormulas = true; // Boolean | Switch ON/OFF formula validation
        Boolean validateInlineXBRL = true; // Boolean | Switch ON/OFF Inline XBRL validation
        Boolean validateTaxonomy = true; // Boolean | Switch ON/OFF taxonomy validation
        Boolean validateXBRL = true; // Boolean | Switch ON/OFF XBRL 2.1 validation
        try {
            Resource result = apiInstance.exportValidationResultsToExcelUsingGET(id, excludedAssertions, excludedFilingRules, validateDimensions, validateFilingRules, validateFormulas, validateInlineXBRL, validateTaxonomy, validateXBRL);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#exportValidationResultsToExcelUsingGET");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID
String *excludedAssertions = excludedAssertions_example; // List of Formula assertion IDs to be excluded (optional)
String *excludedFilingRules = excludedFilingRules_example; // List of filing rules IDs to be excluded (optional)
Boolean *validateDimensions = true; // Switch ON/OFF dimensions validation (optional)
Boolean *validateFilingRules = true; // Switch ON/OFF filing rules validation (optional)
Boolean *validateFormulas = true; // Switch ON/OFF formula validation (optional)
Boolean *validateInlineXBRL = true; // Switch ON/OFF Inline XBRL validation (optional)
Boolean *validateTaxonomy = true; // Switch ON/OFF taxonomy validation (optional)
Boolean *validateXBRL = true; // Switch ON/OFF XBRL 2.1 validation (optional)

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

// Export ESEF report validation results to Excel document
[apiInstance exportValidationResultsToExcelUsingGETWith:id
    excludedAssertions:excludedAssertions
    excludedFilingRules:excludedFilingRules
    validateDimensions:validateDimensions
    validateFilingRules:validateFilingRules
    validateFormulas:validateFormulas
    validateInlineXBRL:validateInlineXBRL
    validateTaxonomy:validateTaxonomy
    validateXBRL:validateXBRL
              completionHandler: ^(Resource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.EsmaesefRestControllerApi()

var id = 789; // {Long} Report ID

var opts = { 
  'excludedAssertions': excludedAssertions_example, // {String} List of Formula assertion IDs to be excluded
  'excludedFilingRules': excludedFilingRules_example, // {String} List of filing rules IDs to be excluded
  'validateDimensions': true, // {Boolean} Switch ON/OFF dimensions validation
  'validateFilingRules': true, // {Boolean} Switch ON/OFF filing rules validation
  'validateFormulas': true, // {Boolean} Switch ON/OFF formula validation
  'validateInlineXBRL': true, // {Boolean} Switch ON/OFF Inline XBRL validation
  'validateTaxonomy': true, // {Boolean} Switch ON/OFF taxonomy validation
  'validateXBRL': true // {Boolean} Switch ON/OFF XBRL 2.1 validation
};

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

namespace Example
{
    public class exportValidationResultsToExcelUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new EsmaesefRestControllerApi();
            var id = 789;  // Long | Report ID
            var excludedAssertions = excludedAssertions_example;  // String | List of Formula assertion IDs to be excluded (optional) 
            var excludedFilingRules = excludedFilingRules_example;  // String | List of filing rules IDs to be excluded (optional) 
            var validateDimensions = true;  // Boolean | Switch ON/OFF dimensions validation (optional) 
            var validateFilingRules = true;  // Boolean | Switch ON/OFF filing rules validation (optional) 
            var validateFormulas = true;  // Boolean | Switch ON/OFF formula validation (optional) 
            var validateInlineXBRL = true;  // Boolean | Switch ON/OFF Inline XBRL validation (optional) 
            var validateTaxonomy = true;  // Boolean | Switch ON/OFF taxonomy validation (optional) 
            var validateXBRL = true;  // Boolean | Switch ON/OFF XBRL 2.1 validation (optional) 

            try
            {
                // Export ESEF report validation results to Excel document
                Resource result = apiInstance.exportValidationResultsToExcelUsingGET(id, excludedAssertions, excludedFilingRules, validateDimensions, validateFilingRules, validateFormulas, validateInlineXBRL, validateTaxonomy, validateXBRL);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EsmaesefRestControllerApi.exportValidationResultsToExcelUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EsmaesefRestControllerApi();
$id = 789; // Long | Report ID
$excludedAssertions = excludedAssertions_example; // String | List of Formula assertion IDs to be excluded
$excludedFilingRules = excludedFilingRules_example; // String | List of filing rules IDs to be excluded
$validateDimensions = true; // Boolean | Switch ON/OFF dimensions validation
$validateFilingRules = true; // Boolean | Switch ON/OFF filing rules validation
$validateFormulas = true; // Boolean | Switch ON/OFF formula validation
$validateInlineXBRL = true; // Boolean | Switch ON/OFF Inline XBRL validation
$validateTaxonomy = true; // Boolean | Switch ON/OFF taxonomy validation
$validateXBRL = true; // Boolean | Switch ON/OFF XBRL 2.1 validation

try {
    $result = $api_instance->exportValidationResultsToExcelUsingGET($id, $excludedAssertions, $excludedFilingRules, $validateDimensions, $validateFilingRules, $validateFormulas, $validateInlineXBRL, $validateTaxonomy, $validateXBRL);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EsmaesefRestControllerApi->exportValidationResultsToExcelUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EsmaesefRestControllerApi;

my $api_instance = WWW::SwaggerClient::EsmaesefRestControllerApi->new();
my $id = 789; # Long | Report ID
my $excludedAssertions = excludedAssertions_example; # String | List of Formula assertion IDs to be excluded
my $excludedFilingRules = excludedFilingRules_example; # String | List of filing rules IDs to be excluded
my $validateDimensions = true; # Boolean | Switch ON/OFF dimensions validation
my $validateFilingRules = true; # Boolean | Switch ON/OFF filing rules validation
my $validateFormulas = true; # Boolean | Switch ON/OFF formula validation
my $validateInlineXBRL = true; # Boolean | Switch ON/OFF Inline XBRL validation
my $validateTaxonomy = true; # Boolean | Switch ON/OFF taxonomy validation
my $validateXBRL = true; # Boolean | Switch ON/OFF XBRL 2.1 validation

eval { 
    my $result = $api_instance->exportValidationResultsToExcelUsingGET(id => $id, excludedAssertions => $excludedAssertions, excludedFilingRules => $excludedFilingRules, validateDimensions => $validateDimensions, validateFilingRules => $validateFilingRules, validateFormulas => $validateFormulas, validateInlineXBRL => $validateInlineXBRL, validateTaxonomy => $validateTaxonomy, validateXBRL => $validateXBRL);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EsmaesefRestControllerApi->exportValidationResultsToExcelUsingGET: $@\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.EsmaesefRestControllerApi()
id = 789 # Long | Report ID
excludedAssertions = excludedAssertions_example # String | List of Formula assertion IDs to be excluded (optional)
excludedFilingRules = excludedFilingRules_example # String | List of filing rules IDs to be excluded (optional)
validateDimensions = true # Boolean | Switch ON/OFF dimensions validation (optional)
validateFilingRules = true # Boolean | Switch ON/OFF filing rules validation (optional)
validateFormulas = true # Boolean | Switch ON/OFF formula validation (optional)
validateInlineXBRL = true # Boolean | Switch ON/OFF Inline XBRL validation (optional)
validateTaxonomy = true # Boolean | Switch ON/OFF taxonomy validation (optional)
validateXBRL = true # Boolean | Switch ON/OFF XBRL 2.1 validation (optional)

try: 
    # Export ESEF report validation results to Excel document
    api_response = api_instance.export_validation_results_to_excel_using_get(id, excludedAssertions=excludedAssertions, excludedFilingRules=excludedFilingRules, validateDimensions=validateDimensions, validateFilingRules=validateFilingRules, validateFormulas=validateFormulas, validateInlineXBRL=validateInlineXBRL, validateTaxonomy=validateTaxonomy, validateXBRL=validateXBRL)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EsmaesefRestControllerApi->exportValidationResultsToExcelUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required
Query parameters
Name Description
excludedAssertions
String
List of Formula assertion IDs to be excluded
excludedFilingRules
String
List of filing rules IDs to be excluded
validateDimensions
Boolean
Switch ON/OFF dimensions validation
validateFilingRules
Boolean
Switch ON/OFF filing rules validation
validateFormulas
Boolean
Switch ON/OFF formula validation
validateInlineXBRL
Boolean
Switch ON/OFF Inline XBRL validation
validateTaxonomy
Boolean
Switch ON/OFF taxonomy validation
validateXBRL
Boolean
Switch ON/OFF XBRL 2.1 validation

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


extractXBRLUsingGET

Extract plain XBRL document from ESEF report


/esma-esef/reports/{id}/extract-xbrl

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/esma-esef/reports/{id}/extract-xbrl"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EsmaesefRestControllerApi;

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

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.extractXBRLUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#extractXBRLUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EsmaesefRestControllerApi;

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.extractXBRLUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#extractXBRLUsingGET");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Extract plain XBRL document from ESEF report
[apiInstance extractXBRLUsingGETWith:id
              completionHandler: ^(Resource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.EsmaesefRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class extractXBRLUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new EsmaesefRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Extract plain XBRL document from ESEF report
                Resource result = apiInstance.extractXBRLUsingGET(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EsmaesefRestControllerApi.extractXBRLUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EsmaesefRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::EsmaesefRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    my $result = $api_instance->extractXBRLUsingGET(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EsmaesefRestControllerApi->extractXBRLUsingGET: $@\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.EsmaesefRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Extract plain XBRL document from ESEF report
    api_response = api_instance.extract_xbrl_using_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EsmaesefRestControllerApi->extractXBRLUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


getOriginalFileUsingGET

Retrieve orginal report as a ZIP file


/esma-esef/reports/{id}/original-file

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/esma-esef/reports/{id}/original-file"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EsmaesefRestControllerApi;

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

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.getOriginalFileUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#getOriginalFileUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EsmaesefRestControllerApi;

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.getOriginalFileUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#getOriginalFileUsingGET");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Retrieve orginal report as a ZIP file
[apiInstance getOriginalFileUsingGETWith:id
              completionHandler: ^(Resource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.EsmaesefRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class getOriginalFileUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new EsmaesefRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Retrieve orginal report as a ZIP file
                Resource result = apiInstance.getOriginalFileUsingGET(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EsmaesefRestControllerApi.getOriginalFileUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EsmaesefRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::EsmaesefRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    my $result = $api_instance->getOriginalFileUsingGET(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EsmaesefRestControllerApi->getOriginalFileUsingGET: $@\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.EsmaesefRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Retrieve orginal report as a ZIP file
    api_response = api_instance.get_original_file_using_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EsmaesefRestControllerApi->getOriginalFileUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist


getOriginalXHTMLFileUsingGET

Retrieve the original report as XHTML document


/esma-esef/reports/{id}/xhtml-file

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/esma-esef/reports/{id}/xhtml-file"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EsmaesefRestControllerApi;

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

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.getOriginalXHTMLFileUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#getOriginalXHTMLFileUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EsmaesefRestControllerApi;

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.getOriginalXHTMLFileUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#getOriginalXHTMLFileUsingGET");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Retrieve the original report as XHTML document
[apiInstance getOriginalXHTMLFileUsingGETWith:id
              completionHandler: ^(Resource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.EsmaesefRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class getOriginalXHTMLFileUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new EsmaesefRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Retrieve the original report as XHTML document
                Resource result = apiInstance.getOriginalXHTMLFileUsingGET(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EsmaesefRestControllerApi.getOriginalXHTMLFileUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EsmaesefRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::EsmaesefRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    my $result = $api_instance->getOriginalXHTMLFileUsingGET(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EsmaesefRestControllerApi->getOriginalXHTMLFileUsingGET: $@\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.EsmaesefRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Retrieve the original report as XHTML document
    api_response = api_instance.get_original_xhtml_file_using_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EsmaesefRestControllerApi->getOriginalXHTMLFileUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


getReportListUsingGET

Retrieve all ESEF reports and retur list of report descriptors


/esma-esef/reports

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/esma-esef/reports?myReportsOnly="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EsmaesefRestControllerApi;

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

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Boolean myReportsOnly = true; // Boolean | Select only current user's or all reports (default=true)
        try {
            array[ReportItemDTO] result = apiInstance.getReportListUsingGET(myReportsOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#getReportListUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EsmaesefRestControllerApi;

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Boolean myReportsOnly = true; // Boolean | Select only current user's or all reports (default=true)
        try {
            array[ReportItemDTO] result = apiInstance.getReportListUsingGET(myReportsOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#getReportListUsingGET");
            e.printStackTrace();
        }
    }
}
Boolean *myReportsOnly = true; // Select only current user's or all reports (default=true) (optional) (default to true)

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

// Retrieve all ESEF reports and retur list of report descriptors
[apiInstance getReportListUsingGETWith:myReportsOnly
              completionHandler: ^(array[ReportItemDTO] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.EsmaesefRestControllerApi()

var opts = { 
  'myReportsOnly': true // {Boolean} Select only current user's or all reports (default=true)
};

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

namespace Example
{
    public class getReportListUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new EsmaesefRestControllerApi();
            var myReportsOnly = true;  // Boolean | Select only current user's or all reports (default=true) (optional)  (default to true)

            try
            {
                // Retrieve all ESEF reports and retur list of report descriptors
                array[ReportItemDTO] result = apiInstance.getReportListUsingGET(myReportsOnly);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EsmaesefRestControllerApi.getReportListUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EsmaesefRestControllerApi();
$myReportsOnly = true; // Boolean | Select only current user's or all reports (default=true)

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

my $api_instance = WWW::SwaggerClient::EsmaesefRestControllerApi->new();
my $myReportsOnly = true; # Boolean | Select only current user's or all reports (default=true)

eval { 
    my $result = $api_instance->getReportListUsingGET(myReportsOnly => $myReportsOnly);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EsmaesefRestControllerApi->getReportListUsingGET: $@\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.EsmaesefRestControllerApi()
myReportsOnly = true # Boolean | Select only current user's or all reports (default=true) (optional) (default to true)

try: 
    # Retrieve all ESEF reports and retur list of report descriptors
    api_response = api_instance.get_report_list_using_get(myReportsOnly=myReportsOnly)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EsmaesefRestControllerApi->getReportListUsingGET: %s\n" % e)

Parameters

Query parameters
Name Description
myReportsOnly
Boolean
Select only current user's or all reports (default=true)

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getReportRelatedFilesUsingGET

Get list of all report related files


/esma-esef/reports/{id}/aux-files

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/esma-esef/reports/{id}/aux-files"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EsmaesefRestControllerApi;

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

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            array[ReportRelatedFileDTO] result = apiInstance.getReportRelatedFilesUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#getReportRelatedFilesUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EsmaesefRestControllerApi;

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            array[ReportRelatedFileDTO] result = apiInstance.getReportRelatedFilesUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#getReportRelatedFilesUsingGET");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Get list of all report related files
[apiInstance getReportRelatedFilesUsingGETWith:id
              completionHandler: ^(array[ReportRelatedFileDTO] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.EsmaesefRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class getReportRelatedFilesUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new EsmaesefRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Get list of all report related files
                array[ReportRelatedFileDTO] result = apiInstance.getReportRelatedFilesUsingGET(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EsmaesefRestControllerApi.getReportRelatedFilesUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EsmaesefRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::EsmaesefRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    my $result = $api_instance->getReportRelatedFilesUsingGET(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EsmaesefRestControllerApi->getReportRelatedFilesUsingGET: $@\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.EsmaesefRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Get list of all report related files
    api_response = api_instance.get_report_related_files_using_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EsmaesefRestControllerApi->getReportRelatedFilesUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


getReportUsingGET

Get report descriptor


/esma-esef/reports/{id}

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/esma-esef/reports/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EsmaesefRestControllerApi;

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

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            ReportItemDTO result = apiInstance.getReportUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#getReportUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EsmaesefRestControllerApi;

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            ReportItemDTO result = apiInstance.getReportUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#getReportUsingGET");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Get report descriptor
[apiInstance getReportUsingGETWith:id
              completionHandler: ^(ReportItemDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.EsmaesefRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class getReportUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new EsmaesefRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Get report descriptor
                ReportItemDTO result = apiInstance.getReportUsingGET(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EsmaesefRestControllerApi.getReportUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EsmaesefRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::EsmaesefRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    my $result = $api_instance->getReportUsingGET(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EsmaesefRestControllerApi->getReportUsingGET: $@\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.EsmaesefRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Get report descriptor
    api_response = api_instance.get_report_using_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EsmaesefRestControllerApi->getReportUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist


getXHTMLFileListUsingGET

Get list of all XHTML documents in the report


/esma-esef/reports/{id}/xhtml-file-list

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/esma-esef/reports/{id}/xhtml-file-list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EsmaesefRestControllerApi;

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

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            array[ReportPackageInlineXBRLFileDTO] result = apiInstance.getXHTMLFileListUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#getXHTMLFileListUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EsmaesefRestControllerApi;

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            array[ReportPackageInlineXBRLFileDTO] result = apiInstance.getXHTMLFileListUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#getXHTMLFileListUsingGET");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Get list of all XHTML documents in the report
[apiInstance getXHTMLFileListUsingGETWith:id
              completionHandler: ^(array[ReportPackageInlineXBRLFileDTO] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.EsmaesefRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class getXHTMLFileListUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new EsmaesefRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Get list of all XHTML documents in the report
                array[ReportPackageInlineXBRLFileDTO] result = apiInstance.getXHTMLFileListUsingGET(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EsmaesefRestControllerApi.getXHTMLFileListUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EsmaesefRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::EsmaesefRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    my $result = $api_instance->getXHTMLFileListUsingGET(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EsmaesefRestControllerApi->getXHTMLFileListUsingGET: $@\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.EsmaesefRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Get list of all XHTML documents in the report
    api_response = api_instance.get_xhtml_file_list_using_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EsmaesefRestControllerApi->getXHTMLFileListUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


getXHTMLFileResourceUsingGET

Get a resource file representing XHTML document from the report


/esma-esef/reports/{id}/xhtml-file-list/{filename}

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/esma-esef/reports/{id}/xhtml-file-list/{filename}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EsmaesefRestControllerApi;

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

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        String filename = filename_example; // String | Name of the file
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.getXHTMLFileResourceUsingGET(filename, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#getXHTMLFileResourceUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EsmaesefRestControllerApi;

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        String filename = filename_example; // String | Name of the file
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.getXHTMLFileResourceUsingGET(filename, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#getXHTMLFileResourceUsingGET");
            e.printStackTrace();
        }
    }
}
String *filename = filename_example; // Name of the file
Long *id = 789; // Report ID

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

// Get a resource file representing XHTML document from the report
[apiInstance getXHTMLFileResourceUsingGETWith:filename
    id:id
              completionHandler: ^(Resource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.EsmaesefRestControllerApi()

var filename = filename_example; // {String} Name of the file

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class getXHTMLFileResourceUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new EsmaesefRestControllerApi();
            var filename = filename_example;  // String | Name of the file
            var id = 789;  // Long | Report ID

            try
            {
                // Get a resource file representing XHTML document from the report
                Resource result = apiInstance.getXHTMLFileResourceUsingGET(filename, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EsmaesefRestControllerApi.getXHTMLFileResourceUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EsmaesefRestControllerApi();
$filename = filename_example; // String | Name of the file
$id = 789; // Long | Report ID

try {
    $result = $api_instance->getXHTMLFileResourceUsingGET($filename, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EsmaesefRestControllerApi->getXHTMLFileResourceUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EsmaesefRestControllerApi;

my $api_instance = WWW::SwaggerClient::EsmaesefRestControllerApi->new();
my $filename = filename_example; # String | Name of the file
my $id = 789; # Long | Report ID

eval { 
    my $result = $api_instance->getXHTMLFileResourceUsingGET(filename => $filename, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EsmaesefRestControllerApi->getXHTMLFileResourceUsingGET: $@\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.EsmaesefRestControllerApi()
filename = filename_example # String | Name of the file
id = 789 # Long | Report ID

try: 
    # Get a resource file representing XHTML document from the report
    api_response = api_instance.get_xhtml_file_resource_using_get(filename, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EsmaesefRestControllerApi->getXHTMLFileResourceUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
filename*
String
Name of the file
Required
id*
Long (int64)
Report ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


insertReportUsingPOST

Add ESEF report to the REST collection. Before adding the file basic validation of the file format is done


/esma-esef/reports

Usage and SDK Samples

curl -X POST "https://localhost:8088/raportado-services/esma-esef/reports"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EsmaesefRestControllerApi;

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

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        File file = /path/to/file.txt; // File | Multipart file - ESEF report to be added
        try {
            Long result = apiInstance.insertReportUsingPOST(file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#insertReportUsingPOST");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EsmaesefRestControllerApi;

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        File file = /path/to/file.txt; // File | Multipart file - ESEF report to be added
        try {
            Long result = apiInstance.insertReportUsingPOST(file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#insertReportUsingPOST");
            e.printStackTrace();
        }
    }
}
File *file = /path/to/file.txt; // Multipart file - ESEF report to be added

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

// Add ESEF report to the REST collection. Before adding the file basic validation of the file format is done
[apiInstance insertReportUsingPOSTWith:file
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.EsmaesefRestControllerApi()

var file = /path/to/file.txt; // {File} Multipart file - ESEF report to be added


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

namespace Example
{
    public class insertReportUsingPOSTExample
    {
        public void main()
        {
            
            var apiInstance = new EsmaesefRestControllerApi();
            var file = new File(); // File | Multipart file - ESEF report to be added

            try
            {
                // Add ESEF report to the REST collection. Before adding the file basic validation of the file format is done
                Long result = apiInstance.insertReportUsingPOST(file);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EsmaesefRestControllerApi.insertReportUsingPOST: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EsmaesefRestControllerApi();
$file = /path/to/file.txt; // File | Multipart file - ESEF report to be added

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

my $api_instance = WWW::SwaggerClient::EsmaesefRestControllerApi->new();
my $file = /path/to/file.txt; # File | Multipart file - ESEF report to be added

eval { 
    my $result = $api_instance->insertReportUsingPOST(file => $file);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EsmaesefRestControllerApi->insertReportUsingPOST: $@\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.EsmaesefRestControllerApi()
file = /path/to/file.txt # File | Multipart file - ESEF report to be added

try: 
    # Add ESEF report to the REST collection. Before adding the file basic validation of the file format is done
    api_response = api_instance.insert_report_using_post(file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EsmaesefRestControllerApi->insertReportUsingPOST: %s\n" % e)

Parameters

Form parameters
Name Description
file*
File
Multipart file - ESEF report to be added
Required

Responses

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Invalid File Format


validateXBRLUsingGET

Validates ESEF report and return validation results in output JSON document


/esma-esef/reports/{id}/validation-results

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/esma-esef/reports/{id}/validation-results?excludedAssertions=&excludedFilingRules=&validateDimensions=&validateFilingRules=&validateFormulas=&validateInlineXBRL=&validateTaxonomy=&validateXBRL="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EsmaesefRestControllerApi;

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

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Long id = 789; // Long | Report ID
        String excludedAssertions = excludedAssertions_example; // String | List of Formula assertion IDs to be excluded
        String excludedFilingRules = excludedFilingRules_example; // String | List of filing rules IDs to be excluded
        Boolean validateDimensions = true; // Boolean | Switch ON/OFF dimensions validation
        Boolean validateFilingRules = true; // Boolean | Switch ON/OFF filing rules validation
        Boolean validateFormulas = true; // Boolean | Switch ON/OFF formula validation
        Boolean validateInlineXBRL = true; // Boolean | Switch ON/OFF Inline XBRL validation
        Boolean validateTaxonomy = true; // Boolean | Switch ON/OFF taxonomy validation
        Boolean validateXBRL = true; // Boolean | Switch ON/OFF XBRL 2.1 validation
        try {
            RapValidationDataDTO result = apiInstance.validateXBRLUsingGET(id, excludedAssertions, excludedFilingRules, validateDimensions, validateFilingRules, validateFormulas, validateInlineXBRL, validateTaxonomy, validateXBRL);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#validateXBRLUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EsmaesefRestControllerApi;

public class EsmaesefRestControllerApiExample {

    public static void main(String[] args) {
        EsmaesefRestControllerApi apiInstance = new EsmaesefRestControllerApi();
        Long id = 789; // Long | Report ID
        String excludedAssertions = excludedAssertions_example; // String | List of Formula assertion IDs to be excluded
        String excludedFilingRules = excludedFilingRules_example; // String | List of filing rules IDs to be excluded
        Boolean validateDimensions = true; // Boolean | Switch ON/OFF dimensions validation
        Boolean validateFilingRules = true; // Boolean | Switch ON/OFF filing rules validation
        Boolean validateFormulas = true; // Boolean | Switch ON/OFF formula validation
        Boolean validateInlineXBRL = true; // Boolean | Switch ON/OFF Inline XBRL validation
        Boolean validateTaxonomy = true; // Boolean | Switch ON/OFF taxonomy validation
        Boolean validateXBRL = true; // Boolean | Switch ON/OFF XBRL 2.1 validation
        try {
            RapValidationDataDTO result = apiInstance.validateXBRLUsingGET(id, excludedAssertions, excludedFilingRules, validateDimensions, validateFilingRules, validateFormulas, validateInlineXBRL, validateTaxonomy, validateXBRL);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefRestControllerApi#validateXBRLUsingGET");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID
String *excludedAssertions = excludedAssertions_example; // List of Formula assertion IDs to be excluded (optional)
String *excludedFilingRules = excludedFilingRules_example; // List of filing rules IDs to be excluded (optional)
Boolean *validateDimensions = true; // Switch ON/OFF dimensions validation (optional)
Boolean *validateFilingRules = true; // Switch ON/OFF filing rules validation (optional)
Boolean *validateFormulas = true; // Switch ON/OFF formula validation (optional)
Boolean *validateInlineXBRL = true; // Switch ON/OFF Inline XBRL validation (optional)
Boolean *validateTaxonomy = true; // Switch ON/OFF taxonomy validation (optional)
Boolean *validateXBRL = true; // Switch ON/OFF XBRL 2.1 validation (optional)

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

// Validates ESEF report and return validation results in output JSON document
[apiInstance validateXBRLUsingGETWith:id
    excludedAssertions:excludedAssertions
    excludedFilingRules:excludedFilingRules
    validateDimensions:validateDimensions
    validateFilingRules:validateFilingRules
    validateFormulas:validateFormulas
    validateInlineXBRL:validateInlineXBRL
    validateTaxonomy:validateTaxonomy
    validateXBRL:validateXBRL
              completionHandler: ^(RapValidationDataDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.EsmaesefRestControllerApi()

var id = 789; // {Long} Report ID

var opts = { 
  'excludedAssertions': excludedAssertions_example, // {String} List of Formula assertion IDs to be excluded
  'excludedFilingRules': excludedFilingRules_example, // {String} List of filing rules IDs to be excluded
  'validateDimensions': true, // {Boolean} Switch ON/OFF dimensions validation
  'validateFilingRules': true, // {Boolean} Switch ON/OFF filing rules validation
  'validateFormulas': true, // {Boolean} Switch ON/OFF formula validation
  'validateInlineXBRL': true, // {Boolean} Switch ON/OFF Inline XBRL validation
  'validateTaxonomy': true, // {Boolean} Switch ON/OFF taxonomy validation
  'validateXBRL': true // {Boolean} Switch ON/OFF XBRL 2.1 validation
};

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

namespace Example
{
    public class validateXBRLUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new EsmaesefRestControllerApi();
            var id = 789;  // Long | Report ID
            var excludedAssertions = excludedAssertions_example;  // String | List of Formula assertion IDs to be excluded (optional) 
            var excludedFilingRules = excludedFilingRules_example;  // String | List of filing rules IDs to be excluded (optional) 
            var validateDimensions = true;  // Boolean | Switch ON/OFF dimensions validation (optional) 
            var validateFilingRules = true;  // Boolean | Switch ON/OFF filing rules validation (optional) 
            var validateFormulas = true;  // Boolean | Switch ON/OFF formula validation (optional) 
            var validateInlineXBRL = true;  // Boolean | Switch ON/OFF Inline XBRL validation (optional) 
            var validateTaxonomy = true;  // Boolean | Switch ON/OFF taxonomy validation (optional) 
            var validateXBRL = true;  // Boolean | Switch ON/OFF XBRL 2.1 validation (optional) 

            try
            {
                // Validates ESEF report and return validation results in output JSON document
                RapValidationDataDTO result = apiInstance.validateXBRLUsingGET(id, excludedAssertions, excludedFilingRules, validateDimensions, validateFilingRules, validateFormulas, validateInlineXBRL, validateTaxonomy, validateXBRL);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EsmaesefRestControllerApi.validateXBRLUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EsmaesefRestControllerApi();
$id = 789; // Long | Report ID
$excludedAssertions = excludedAssertions_example; // String | List of Formula assertion IDs to be excluded
$excludedFilingRules = excludedFilingRules_example; // String | List of filing rules IDs to be excluded
$validateDimensions = true; // Boolean | Switch ON/OFF dimensions validation
$validateFilingRules = true; // Boolean | Switch ON/OFF filing rules validation
$validateFormulas = true; // Boolean | Switch ON/OFF formula validation
$validateInlineXBRL = true; // Boolean | Switch ON/OFF Inline XBRL validation
$validateTaxonomy = true; // Boolean | Switch ON/OFF taxonomy validation
$validateXBRL = true; // Boolean | Switch ON/OFF XBRL 2.1 validation

try {
    $result = $api_instance->validateXBRLUsingGET($id, $excludedAssertions, $excludedFilingRules, $validateDimensions, $validateFilingRules, $validateFormulas, $validateInlineXBRL, $validateTaxonomy, $validateXBRL);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EsmaesefRestControllerApi->validateXBRLUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EsmaesefRestControllerApi;

my $api_instance = WWW::SwaggerClient::EsmaesefRestControllerApi->new();
my $id = 789; # Long | Report ID
my $excludedAssertions = excludedAssertions_example; # String | List of Formula assertion IDs to be excluded
my $excludedFilingRules = excludedFilingRules_example; # String | List of filing rules IDs to be excluded
my $validateDimensions = true; # Boolean | Switch ON/OFF dimensions validation
my $validateFilingRules = true; # Boolean | Switch ON/OFF filing rules validation
my $validateFormulas = true; # Boolean | Switch ON/OFF formula validation
my $validateInlineXBRL = true; # Boolean | Switch ON/OFF Inline XBRL validation
my $validateTaxonomy = true; # Boolean | Switch ON/OFF taxonomy validation
my $validateXBRL = true; # Boolean | Switch ON/OFF XBRL 2.1 validation

eval { 
    my $result = $api_instance->validateXBRLUsingGET(id => $id, excludedAssertions => $excludedAssertions, excludedFilingRules => $excludedFilingRules, validateDimensions => $validateDimensions, validateFilingRules => $validateFilingRules, validateFormulas => $validateFormulas, validateInlineXBRL => $validateInlineXBRL, validateTaxonomy => $validateTaxonomy, validateXBRL => $validateXBRL);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EsmaesefRestControllerApi->validateXBRLUsingGET: $@\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.EsmaesefRestControllerApi()
id = 789 # Long | Report ID
excludedAssertions = excludedAssertions_example # String | List of Formula assertion IDs to be excluded (optional)
excludedFilingRules = excludedFilingRules_example # String | List of filing rules IDs to be excluded (optional)
validateDimensions = true # Boolean | Switch ON/OFF dimensions validation (optional)
validateFilingRules = true # Boolean | Switch ON/OFF filing rules validation (optional)
validateFormulas = true # Boolean | Switch ON/OFF formula validation (optional)
validateInlineXBRL = true # Boolean | Switch ON/OFF Inline XBRL validation (optional)
validateTaxonomy = true # Boolean | Switch ON/OFF taxonomy validation (optional)
validateXBRL = true # Boolean | Switch ON/OFF XBRL 2.1 validation (optional)

try: 
    # Validates ESEF report and return validation results in output JSON document
    api_response = api_instance.validate_xbrl_using_get(id, excludedAssertions=excludedAssertions, excludedFilingRules=excludedFilingRules, validateDimensions=validateDimensions, validateFilingRules=validateFilingRules, validateFormulas=validateFormulas, validateInlineXBRL=validateInlineXBRL, validateTaxonomy=validateTaxonomy, validateXBRL=validateXBRL)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EsmaesefRestControllerApi->validateXBRLUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required
Query parameters
Name Description
excludedAssertions
String
List of Formula assertion IDs to be excluded
excludedFilingRules
String
List of filing rules IDs to be excluded
validateDimensions
Boolean
Switch ON/OFF dimensions validation
validateFilingRules
Boolean
Switch ON/OFF filing rules validation
validateFormulas
Boolean
Switch ON/OFF formula validation
validateInlineXBRL
Boolean
Switch ON/OFF Inline XBRL validation
validateTaxonomy
Boolean
Switch ON/OFF taxonomy validation
validateXBRL
Boolean
Switch ON/OFF XBRL 2.1 validation

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


EsmaesefViewerRestController

getCalculationResultsUsingGET

Get results of Calculation validation


/esma-esef/reports/{id}/calculation

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/esma-esef/reports/{id}/calculation"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EsmaesefViewerRestControllerApi;

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

public class EsmaesefViewerRestControllerApiExample {

    public static void main(String[] args) {
        
        EsmaesefViewerRestControllerApi apiInstance = new EsmaesefViewerRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            array[CalculationResult] result = apiInstance.getCalculationResultsUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefViewerRestControllerApi#getCalculationResultsUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EsmaesefViewerRestControllerApi;

public class EsmaesefViewerRestControllerApiExample {

    public static void main(String[] args) {
        EsmaesefViewerRestControllerApi apiInstance = new EsmaesefViewerRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            array[CalculationResult] result = apiInstance.getCalculationResultsUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefViewerRestControllerApi#getCalculationResultsUsingGET");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Get results of Calculation validation
[apiInstance getCalculationResultsUsingGETWith:id
              completionHandler: ^(array[CalculationResult] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.EsmaesefViewerRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class getCalculationResultsUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new EsmaesefViewerRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Get results of Calculation validation
                array[CalculationResult] result = apiInstance.getCalculationResultsUsingGET(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EsmaesefViewerRestControllerApi.getCalculationResultsUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EsmaesefViewerRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::EsmaesefViewerRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    my $result = $api_instance->getCalculationResultsUsingGET(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EsmaesefViewerRestControllerApi->getCalculationResultsUsingGET: $@\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.EsmaesefViewerRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Get results of Calculation validation
    api_response = api_instance.get_calculation_results_using_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EsmaesefViewerRestControllerApi->getCalculationResultsUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


getDetailsUsingGET

Get details of the report


/esma-esef/reports/{id}/details

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/esma-esef/reports/{id}/details"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EsmaesefViewerRestControllerApi;

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

public class EsmaesefViewerRestControllerApiExample {

    public static void main(String[] args) {
        
        EsmaesefViewerRestControllerApi apiInstance = new EsmaesefViewerRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            DetailsBean result = apiInstance.getDetailsUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefViewerRestControllerApi#getDetailsUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EsmaesefViewerRestControllerApi;

public class EsmaesefViewerRestControllerApiExample {

    public static void main(String[] args) {
        EsmaesefViewerRestControllerApi apiInstance = new EsmaesefViewerRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            DetailsBean result = apiInstance.getDetailsUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefViewerRestControllerApi#getDetailsUsingGET");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Get details of the report
[apiInstance getDetailsUsingGETWith:id
              completionHandler: ^(DetailsBean output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.EsmaesefViewerRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class getDetailsUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new EsmaesefViewerRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Get details of the report
                DetailsBean result = apiInstance.getDetailsUsingGET(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EsmaesefViewerRestControllerApi.getDetailsUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EsmaesefViewerRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::EsmaesefViewerRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    my $result = $api_instance->getDetailsUsingGET(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EsmaesefViewerRestControllerApi->getDetailsUsingGET: $@\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.EsmaesefViewerRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Get details of the report
    api_response = api_instance.get_details_using_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EsmaesefViewerRestControllerApi->getDetailsUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


getFactsGrouppedByConceptsUsingGET

Get report facts grouped by concepts


/esma-esef/reports/{id}/facts-by-concepts

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/esma-esef/reports/{id}/facts-by-concepts?conceptLabel=&endDate=&instant=&matchWholeConceptLabelOnly=&startDate=&type=&unitQName="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EsmaesefViewerRestControllerApi;

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

public class EsmaesefViewerRestControllerApiExample {

    public static void main(String[] args) {
        
        EsmaesefViewerRestControllerApi apiInstance = new EsmaesefViewerRestControllerApi();
        Long id = 789; // Long | Report ID
        String conceptLabel = conceptLabel_example; // String | Label of the concept
        date endDate = 2013-10-20; // date | Context's end date
        Boolean instant = true; // Boolean | Whether instant date of the context should be used
        Boolean matchWholeConceptLabelOnly = true; // Boolean | Whether exact match of concept's label should be used
        date startDate = 2013-10-20; // date | Context's start date
        String type = type_example; // String | XBRL type name
        String unitQName = unitQName_example; // String | QName of the XBRL unit
        try {
            array[FactsByConceptDTO] result = apiInstance.getFactsGrouppedByConceptsUsingGET(id, conceptLabel, endDate, instant, matchWholeConceptLabelOnly, startDate, type, unitQName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefViewerRestControllerApi#getFactsGrouppedByConceptsUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EsmaesefViewerRestControllerApi;

public class EsmaesefViewerRestControllerApiExample {

    public static void main(String[] args) {
        EsmaesefViewerRestControllerApi apiInstance = new EsmaesefViewerRestControllerApi();
        Long id = 789; // Long | Report ID
        String conceptLabel = conceptLabel_example; // String | Label of the concept
        date endDate = 2013-10-20; // date | Context's end date
        Boolean instant = true; // Boolean | Whether instant date of the context should be used
        Boolean matchWholeConceptLabelOnly = true; // Boolean | Whether exact match of concept's label should be used
        date startDate = 2013-10-20; // date | Context's start date
        String type = type_example; // String | XBRL type name
        String unitQName = unitQName_example; // String | QName of the XBRL unit
        try {
            array[FactsByConceptDTO] result = apiInstance.getFactsGrouppedByConceptsUsingGET(id, conceptLabel, endDate, instant, matchWholeConceptLabelOnly, startDate, type, unitQName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefViewerRestControllerApi#getFactsGrouppedByConceptsUsingGET");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID
String *conceptLabel = conceptLabel_example; // Label of the concept (optional)
date *endDate = 2013-10-20; // Context's end date (optional)
Boolean *instant = true; // Whether instant date of the context should be used (optional)
Boolean *matchWholeConceptLabelOnly = true; // Whether exact match of concept's label should be used (optional)
date *startDate = 2013-10-20; // Context's start date (optional)
String *type = type_example; // XBRL type name (optional)
String *unitQName = unitQName_example; // QName of the XBRL unit (optional)

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

// Get report facts grouped by concepts
[apiInstance getFactsGrouppedByConceptsUsingGETWith:id
    conceptLabel:conceptLabel
    endDate:endDate
    instant:instant
    matchWholeConceptLabelOnly:matchWholeConceptLabelOnly
    startDate:startDate
    type:type
    unitQName:unitQName
              completionHandler: ^(array[FactsByConceptDTO] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.EsmaesefViewerRestControllerApi()

var id = 789; // {Long} Report ID

var opts = { 
  'conceptLabel': conceptLabel_example, // {String} Label of the concept
  'endDate': 2013-10-20, // {date} Context's end date
  'instant': true, // {Boolean} Whether instant date of the context should be used
  'matchWholeConceptLabelOnly': true, // {Boolean} Whether exact match of concept's label should be used
  'startDate': 2013-10-20, // {date} Context's start date
  'type': type_example, // {String} XBRL type name
  'unitQName': unitQName_example // {String} QName of the XBRL unit
};

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

namespace Example
{
    public class getFactsGrouppedByConceptsUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new EsmaesefViewerRestControllerApi();
            var id = 789;  // Long | Report ID
            var conceptLabel = conceptLabel_example;  // String | Label of the concept (optional) 
            var endDate = 2013-10-20;  // date | Context's end date (optional) 
            var instant = true;  // Boolean | Whether instant date of the context should be used (optional) 
            var matchWholeConceptLabelOnly = true;  // Boolean | Whether exact match of concept's label should be used (optional) 
            var startDate = 2013-10-20;  // date | Context's start date (optional) 
            var type = type_example;  // String | XBRL type name (optional) 
            var unitQName = unitQName_example;  // String | QName of the XBRL unit (optional) 

            try
            {
                // Get report facts grouped by concepts
                array[FactsByConceptDTO] result = apiInstance.getFactsGrouppedByConceptsUsingGET(id, conceptLabel, endDate, instant, matchWholeConceptLabelOnly, startDate, type, unitQName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EsmaesefViewerRestControllerApi.getFactsGrouppedByConceptsUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EsmaesefViewerRestControllerApi();
$id = 789; // Long | Report ID
$conceptLabel = conceptLabel_example; // String | Label of the concept
$endDate = 2013-10-20; // date | Context's end date
$instant = true; // Boolean | Whether instant date of the context should be used
$matchWholeConceptLabelOnly = true; // Boolean | Whether exact match of concept's label should be used
$startDate = 2013-10-20; // date | Context's start date
$type = type_example; // String | XBRL type name
$unitQName = unitQName_example; // String | QName of the XBRL unit

try {
    $result = $api_instance->getFactsGrouppedByConceptsUsingGET($id, $conceptLabel, $endDate, $instant, $matchWholeConceptLabelOnly, $startDate, $type, $unitQName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EsmaesefViewerRestControllerApi->getFactsGrouppedByConceptsUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EsmaesefViewerRestControllerApi;

my $api_instance = WWW::SwaggerClient::EsmaesefViewerRestControllerApi->new();
my $id = 789; # Long | Report ID
my $conceptLabel = conceptLabel_example; # String | Label of the concept
my $endDate = 2013-10-20; # date | Context's end date
my $instant = true; # Boolean | Whether instant date of the context should be used
my $matchWholeConceptLabelOnly = true; # Boolean | Whether exact match of concept's label should be used
my $startDate = 2013-10-20; # date | Context's start date
my $type = type_example; # String | XBRL type name
my $unitQName = unitQName_example; # String | QName of the XBRL unit

eval { 
    my $result = $api_instance->getFactsGrouppedByConceptsUsingGET(id => $id, conceptLabel => $conceptLabel, endDate => $endDate, instant => $instant, matchWholeConceptLabelOnly => $matchWholeConceptLabelOnly, startDate => $startDate, type => $type, unitQName => $unitQName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EsmaesefViewerRestControllerApi->getFactsGrouppedByConceptsUsingGET: $@\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.EsmaesefViewerRestControllerApi()
id = 789 # Long | Report ID
conceptLabel = conceptLabel_example # String | Label of the concept (optional)
endDate = 2013-10-20 # date | Context's end date (optional)
instant = true # Boolean | Whether instant date of the context should be used (optional)
matchWholeConceptLabelOnly = true # Boolean | Whether exact match of concept's label should be used (optional)
startDate = 2013-10-20 # date | Context's start date (optional)
type = type_example # String | XBRL type name (optional)
unitQName = unitQName_example # String | QName of the XBRL unit (optional)

try: 
    # Get report facts grouped by concepts
    api_response = api_instance.get_facts_groupped_by_concepts_using_get(id, conceptLabel=conceptLabel, endDate=endDate, instant=instant, matchWholeConceptLabelOnly=matchWholeConceptLabelOnly, startDate=startDate, type=type, unitQName=unitQName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EsmaesefViewerRestControllerApi->getFactsGrouppedByConceptsUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required
Query parameters
Name Description
conceptLabel
String
Label of the concept
endDate
date (date)
Context's end date
instant
Boolean
Whether instant date of the context should be used
matchWholeConceptLabelOnly
Boolean
Whether exact match of concept's label should be used
startDate
date (date)
Context's start date
type
String
XBRL type name
unitQName
String
QName of the XBRL unit

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


getFactsUsingGET

Get facts from the report


/esma-esef/reports/{id}/facts

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/esma-esef/reports/{id}/facts?conceptLabel=&endDate=&instant=&matchWholeConceptLabelOnly=&startDate=&type=&unitQName="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EsmaesefViewerRestControllerApi;

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

public class EsmaesefViewerRestControllerApiExample {

    public static void main(String[] args) {
        
        EsmaesefViewerRestControllerApi apiInstance = new EsmaesefViewerRestControllerApi();
        Long id = 789; // Long | Report ID
        String conceptLabel = conceptLabel_example; // String | Label of the concept
        date endDate = 2013-10-20; // date | Context's end date
        Boolean instant = true; // Boolean | Whether instant date of the context should be used
        Boolean matchWholeConceptLabelOnly = true; // Boolean | Whether exact match of concept's label should be used
        date startDate = 2013-10-20; // date | Context's start date
        String type = type_example; // String | XBRL type name
        String unitQName = unitQName_example; // String | QName of the XBRL unit
        try {
            array[FactBean] result = apiInstance.getFactsUsingGET(id, conceptLabel, endDate, instant, matchWholeConceptLabelOnly, startDate, type, unitQName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefViewerRestControllerApi#getFactsUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EsmaesefViewerRestControllerApi;

public class EsmaesefViewerRestControllerApiExample {

    public static void main(String[] args) {
        EsmaesefViewerRestControllerApi apiInstance = new EsmaesefViewerRestControllerApi();
        Long id = 789; // Long | Report ID
        String conceptLabel = conceptLabel_example; // String | Label of the concept
        date endDate = 2013-10-20; // date | Context's end date
        Boolean instant = true; // Boolean | Whether instant date of the context should be used
        Boolean matchWholeConceptLabelOnly = true; // Boolean | Whether exact match of concept's label should be used
        date startDate = 2013-10-20; // date | Context's start date
        String type = type_example; // String | XBRL type name
        String unitQName = unitQName_example; // String | QName of the XBRL unit
        try {
            array[FactBean] result = apiInstance.getFactsUsingGET(id, conceptLabel, endDate, instant, matchWholeConceptLabelOnly, startDate, type, unitQName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefViewerRestControllerApi#getFactsUsingGET");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID
String *conceptLabel = conceptLabel_example; // Label of the concept (optional)
date *endDate = 2013-10-20; // Context's end date (optional)
Boolean *instant = true; // Whether instant date of the context should be used (optional)
Boolean *matchWholeConceptLabelOnly = true; // Whether exact match of concept's label should be used (optional)
date *startDate = 2013-10-20; // Context's start date (optional)
String *type = type_example; // XBRL type name (optional)
String *unitQName = unitQName_example; // QName of the XBRL unit (optional)

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

// Get facts from the report
[apiInstance getFactsUsingGETWith:id
    conceptLabel:conceptLabel
    endDate:endDate
    instant:instant
    matchWholeConceptLabelOnly:matchWholeConceptLabelOnly
    startDate:startDate
    type:type
    unitQName:unitQName
              completionHandler: ^(array[FactBean] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.EsmaesefViewerRestControllerApi()

var id = 789; // {Long} Report ID

var opts = { 
  'conceptLabel': conceptLabel_example, // {String} Label of the concept
  'endDate': 2013-10-20, // {date} Context's end date
  'instant': true, // {Boolean} Whether instant date of the context should be used
  'matchWholeConceptLabelOnly': true, // {Boolean} Whether exact match of concept's label should be used
  'startDate': 2013-10-20, // {date} Context's start date
  'type': type_example, // {String} XBRL type name
  'unitQName': unitQName_example // {String} QName of the XBRL unit
};

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

namespace Example
{
    public class getFactsUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new EsmaesefViewerRestControllerApi();
            var id = 789;  // Long | Report ID
            var conceptLabel = conceptLabel_example;  // String | Label of the concept (optional) 
            var endDate = 2013-10-20;  // date | Context's end date (optional) 
            var instant = true;  // Boolean | Whether instant date of the context should be used (optional) 
            var matchWholeConceptLabelOnly = true;  // Boolean | Whether exact match of concept's label should be used (optional) 
            var startDate = 2013-10-20;  // date | Context's start date (optional) 
            var type = type_example;  // String | XBRL type name (optional) 
            var unitQName = unitQName_example;  // String | QName of the XBRL unit (optional) 

            try
            {
                // Get facts from the report
                array[FactBean] result = apiInstance.getFactsUsingGET(id, conceptLabel, endDate, instant, matchWholeConceptLabelOnly, startDate, type, unitQName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EsmaesefViewerRestControllerApi.getFactsUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EsmaesefViewerRestControllerApi();
$id = 789; // Long | Report ID
$conceptLabel = conceptLabel_example; // String | Label of the concept
$endDate = 2013-10-20; // date | Context's end date
$instant = true; // Boolean | Whether instant date of the context should be used
$matchWholeConceptLabelOnly = true; // Boolean | Whether exact match of concept's label should be used
$startDate = 2013-10-20; // date | Context's start date
$type = type_example; // String | XBRL type name
$unitQName = unitQName_example; // String | QName of the XBRL unit

try {
    $result = $api_instance->getFactsUsingGET($id, $conceptLabel, $endDate, $instant, $matchWholeConceptLabelOnly, $startDate, $type, $unitQName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EsmaesefViewerRestControllerApi->getFactsUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EsmaesefViewerRestControllerApi;

my $api_instance = WWW::SwaggerClient::EsmaesefViewerRestControllerApi->new();
my $id = 789; # Long | Report ID
my $conceptLabel = conceptLabel_example; # String | Label of the concept
my $endDate = 2013-10-20; # date | Context's end date
my $instant = true; # Boolean | Whether instant date of the context should be used
my $matchWholeConceptLabelOnly = true; # Boolean | Whether exact match of concept's label should be used
my $startDate = 2013-10-20; # date | Context's start date
my $type = type_example; # String | XBRL type name
my $unitQName = unitQName_example; # String | QName of the XBRL unit

eval { 
    my $result = $api_instance->getFactsUsingGET(id => $id, conceptLabel => $conceptLabel, endDate => $endDate, instant => $instant, matchWholeConceptLabelOnly => $matchWholeConceptLabelOnly, startDate => $startDate, type => $type, unitQName => $unitQName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EsmaesefViewerRestControllerApi->getFactsUsingGET: $@\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.EsmaesefViewerRestControllerApi()
id = 789 # Long | Report ID
conceptLabel = conceptLabel_example # String | Label of the concept (optional)
endDate = 2013-10-20 # date | Context's end date (optional)
instant = true # Boolean | Whether instant date of the context should be used (optional)
matchWholeConceptLabelOnly = true # Boolean | Whether exact match of concept's label should be used (optional)
startDate = 2013-10-20 # date | Context's start date (optional)
type = type_example # String | XBRL type name (optional)
unitQName = unitQName_example # String | QName of the XBRL unit (optional)

try: 
    # Get facts from the report
    api_response = api_instance.get_facts_using_get(id, conceptLabel=conceptLabel, endDate=endDate, instant=instant, matchWholeConceptLabelOnly=matchWholeConceptLabelOnly, startDate=startDate, type=type, unitQName=unitQName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EsmaesefViewerRestControllerApi->getFactsUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required
Query parameters
Name Description
conceptLabel
String
Label of the concept
endDate
date (date)
Context's end date
instant
Boolean
Whether instant date of the context should be used
matchWholeConceptLabelOnly
Boolean
Whether exact match of concept's label should be used
startDate
date (date)
Context's start date
type
String
XBRL type name
unitQName
String
QName of the XBRL unit

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


getInlineXBRLViewerNewUsingGET

Execute Inline XBRL Viewer component


/esma-esef/reports/{id}/javascript-viewer-new

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/esma-esef/reports/{id}/javascript-viewer-new"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EsmaesefViewerRestControllerApi;

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

public class EsmaesefViewerRestControllerApiExample {

    public static void main(String[] args) {
        
        EsmaesefViewerRestControllerApi apiInstance = new EsmaesefViewerRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.getInlineXBRLViewerNewUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefViewerRestControllerApi#getInlineXBRLViewerNewUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EsmaesefViewerRestControllerApi;

public class EsmaesefViewerRestControllerApiExample {

    public static void main(String[] args) {
        EsmaesefViewerRestControllerApi apiInstance = new EsmaesefViewerRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.getInlineXBRLViewerNewUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefViewerRestControllerApi#getInlineXBRLViewerNewUsingGET");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Execute Inline XBRL Viewer component
[apiInstance getInlineXBRLViewerNewUsingGETWith:id
              completionHandler: ^(Resource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.EsmaesefViewerRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class getInlineXBRLViewerNewUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new EsmaesefViewerRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Execute Inline XBRL Viewer component
                Resource result = apiInstance.getInlineXBRLViewerNewUsingGET(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EsmaesefViewerRestControllerApi.getInlineXBRLViewerNewUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EsmaesefViewerRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::EsmaesefViewerRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    my $result = $api_instance->getInlineXBRLViewerNewUsingGET(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EsmaesefViewerRestControllerApi->getInlineXBRLViewerNewUsingGET: $@\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.EsmaesefViewerRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Execute Inline XBRL Viewer component
    api_response = api_instance.get_inline_xbrl_viewer_new_using_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EsmaesefViewerRestControllerApi->getInlineXBRLViewerNewUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


getInlineXBRLViewerUsingGET

Execute Inline XBRL Viewer component


/esma-esef/reports/{id}/javascript-viewer

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/esma-esef/reports/{id}/javascript-viewer"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EsmaesefViewerRestControllerApi;

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

public class EsmaesefViewerRestControllerApiExample {

    public static void main(String[] args) {
        
        EsmaesefViewerRestControllerApi apiInstance = new EsmaesefViewerRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.getInlineXBRLViewerUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefViewerRestControllerApi#getInlineXBRLViewerUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EsmaesefViewerRestControllerApi;

public class EsmaesefViewerRestControllerApiExample {

    public static void main(String[] args) {
        EsmaesefViewerRestControllerApi apiInstance = new EsmaesefViewerRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.getInlineXBRLViewerUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EsmaesefViewerRestControllerApi#getInlineXBRLViewerUsingGET");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Execute Inline XBRL Viewer component
[apiInstance getInlineXBRLViewerUsingGETWith:id
              completionHandler: ^(Resource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.EsmaesefViewerRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class getInlineXBRLViewerUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new EsmaesefViewerRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Execute Inline XBRL Viewer component
                Resource result = apiInstance.getInlineXBRLViewerUsingGET(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EsmaesefViewerRestControllerApi.getInlineXBRLViewerUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\EsmaesefViewerRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::EsmaesefViewerRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    my $result = $api_instance->getInlineXBRLViewerUsingGET(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EsmaesefViewerRestControllerApi->getInlineXBRLViewerUsingGET: $@\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.EsmaesefViewerRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Execute Inline XBRL Viewer component
    api_response = api_instance.get_inline_xbrl_viewer_using_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EsmaesefViewerRestControllerApi->getInlineXBRLViewerUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


InlineXbrlRestController

deleteReportUsingDELETE1

Delete Inline XBRL report from REST collection


/inline-xbrl/reports/{id}

Usage and SDK Samples

curl -X DELETE "https://localhost:8088/raportado-services/inline-xbrl/reports/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InlineXbrlRestControllerApi;

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

public class InlineXbrlRestControllerApiExample {

    public static void main(String[] args) {
        
        InlineXbrlRestControllerApi apiInstance = new InlineXbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            apiInstance.deleteReportUsingDELETE1(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlineXbrlRestControllerApi#deleteReportUsingDELETE1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InlineXbrlRestControllerApi;

public class InlineXbrlRestControllerApiExample {

    public static void main(String[] args) {
        InlineXbrlRestControllerApi apiInstance = new InlineXbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            apiInstance.deleteReportUsingDELETE1(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlineXbrlRestControllerApi#deleteReportUsingDELETE1");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Delete Inline XBRL report from REST collection
[apiInstance deleteReportUsingDELETE1With:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.InlineXbrlRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class deleteReportUsingDELETE1Example
    {
        public void main()
        {
            
            var apiInstance = new InlineXbrlRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Delete Inline XBRL report from REST collection
                apiInstance.deleteReportUsingDELETE1(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InlineXbrlRestControllerApi.deleteReportUsingDELETE1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InlineXbrlRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::InlineXbrlRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    $api_instance->deleteReportUsingDELETE1(id => $id);
};
if ($@) {
    warn "Exception when calling InlineXbrlRestControllerApi->deleteReportUsingDELETE1: $@\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.InlineXbrlRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Delete Inline XBRL report from REST collection
    api_instance.delete_report_using_delete1(id)
except ApiException as e:
    print("Exception when calling InlineXbrlRestControllerApi->deleteReportUsingDELETE1: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 204 - No Content

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist


exportJSONUsingGET1

Export Inline XBRL report data to JSON document


/inline-xbrl/reports/{id}/export-to-json

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/inline-xbrl/reports/{id}/export-to-json"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InlineXbrlRestControllerApi;

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

public class InlineXbrlRestControllerApiExample {

    public static void main(String[] args) {
        
        InlineXbrlRestControllerApi apiInstance = new InlineXbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.exportJSONUsingGET1(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlineXbrlRestControllerApi#exportJSONUsingGET1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InlineXbrlRestControllerApi;

public class InlineXbrlRestControllerApiExample {

    public static void main(String[] args) {
        InlineXbrlRestControllerApi apiInstance = new InlineXbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.exportJSONUsingGET1(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlineXbrlRestControllerApi#exportJSONUsingGET1");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Export Inline XBRL report data to JSON document
[apiInstance exportJSONUsingGET1With:id
              completionHandler: ^(Resource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.InlineXbrlRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class exportJSONUsingGET1Example
    {
        public void main()
        {
            
            var apiInstance = new InlineXbrlRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Export Inline XBRL report data to JSON document
                Resource result = apiInstance.exportJSONUsingGET1(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InlineXbrlRestControllerApi.exportJSONUsingGET1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InlineXbrlRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::InlineXbrlRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    my $result = $api_instance->exportJSONUsingGET1(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InlineXbrlRestControllerApi->exportJSONUsingGET1: $@\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.InlineXbrlRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Export Inline XBRL report data to JSON document
    api_response = api_instance.export_json_using_get1(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InlineXbrlRestControllerApi->exportJSONUsingGET1: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


extractXBRLUsingGET1

Extract plain XBRL document from Inline XBRL report


/inline-xbrl/reports/{id}/extract-xbrl

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/inline-xbrl/reports/{id}/extract-xbrl"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InlineXbrlRestControllerApi;

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

public class InlineXbrlRestControllerApiExample {

    public static void main(String[] args) {
        
        InlineXbrlRestControllerApi apiInstance = new InlineXbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.extractXBRLUsingGET1(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlineXbrlRestControllerApi#extractXBRLUsingGET1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InlineXbrlRestControllerApi;

public class InlineXbrlRestControllerApiExample {

    public static void main(String[] args) {
        InlineXbrlRestControllerApi apiInstance = new InlineXbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.extractXBRLUsingGET1(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlineXbrlRestControllerApi#extractXBRLUsingGET1");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Extract plain XBRL document from Inline XBRL report
[apiInstance extractXBRLUsingGET1With:id
              completionHandler: ^(Resource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.InlineXbrlRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class extractXBRLUsingGET1Example
    {
        public void main()
        {
            
            var apiInstance = new InlineXbrlRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Extract plain XBRL document from Inline XBRL report
                Resource result = apiInstance.extractXBRLUsingGET1(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InlineXbrlRestControllerApi.extractXBRLUsingGET1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InlineXbrlRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::InlineXbrlRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    my $result = $api_instance->extractXBRLUsingGET1(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InlineXbrlRestControllerApi->extractXBRLUsingGET1: $@\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.InlineXbrlRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Extract plain XBRL document from Inline XBRL report
    api_response = api_instance.extract_xbrl_using_get1(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InlineXbrlRestControllerApi->extractXBRLUsingGET1: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


getOriginalFileUsingGET1

Get source Inline XBRL report file


/inline-xbrl/reports/{id}/xhtml-file

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/inline-xbrl/reports/{id}/xhtml-file"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InlineXbrlRestControllerApi;

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

public class InlineXbrlRestControllerApiExample {

    public static void main(String[] args) {
        
        InlineXbrlRestControllerApi apiInstance = new InlineXbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.getOriginalFileUsingGET1(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlineXbrlRestControllerApi#getOriginalFileUsingGET1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InlineXbrlRestControllerApi;

public class InlineXbrlRestControllerApiExample {

    public static void main(String[] args) {
        InlineXbrlRestControllerApi apiInstance = new InlineXbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.getOriginalFileUsingGET1(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlineXbrlRestControllerApi#getOriginalFileUsingGET1");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Get source Inline XBRL report file
[apiInstance getOriginalFileUsingGET1With:id
              completionHandler: ^(Resource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.InlineXbrlRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class getOriginalFileUsingGET1Example
    {
        public void main()
        {
            
            var apiInstance = new InlineXbrlRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Get source Inline XBRL report file
                Resource result = apiInstance.getOriginalFileUsingGET1(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InlineXbrlRestControllerApi.getOriginalFileUsingGET1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InlineXbrlRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::InlineXbrlRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    my $result = $api_instance->getOriginalFileUsingGET1(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InlineXbrlRestControllerApi->getOriginalFileUsingGET1: $@\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.InlineXbrlRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Get source Inline XBRL report file
    api_response = api_instance.get_original_file_using_get1(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InlineXbrlRestControllerApi->getOriginalFileUsingGET1: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist


getReportListUsingGET1

Get descriptors of all Inline XBRL reports in REST collection


/inline-xbrl/reports

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/inline-xbrl/reports"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InlineXbrlRestControllerApi;

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

public class InlineXbrlRestControllerApiExample {

    public static void main(String[] args) {
        
        InlineXbrlRestControllerApi apiInstance = new InlineXbrlRestControllerApi();
        try {
            array[ReportItemDTO] result = apiInstance.getReportListUsingGET1();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlineXbrlRestControllerApi#getReportListUsingGET1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InlineXbrlRestControllerApi;

public class InlineXbrlRestControllerApiExample {

    public static void main(String[] args) {
        InlineXbrlRestControllerApi apiInstance = new InlineXbrlRestControllerApi();
        try {
            array[ReportItemDTO] result = apiInstance.getReportListUsingGET1();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlineXbrlRestControllerApi#getReportListUsingGET1");
            e.printStackTrace();
        }
    }
}

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

// Get descriptors of all Inline XBRL reports in REST collection
[apiInstance getReportListUsingGET1WithCompletionHandler: 
              ^(array[ReportItemDTO] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.InlineXbrlRestControllerApi()

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

namespace Example
{
    public class getReportListUsingGET1Example
    {
        public void main()
        {
            
            var apiInstance = new InlineXbrlRestControllerApi();

            try
            {
                // Get descriptors of all Inline XBRL reports in REST collection
                array[ReportItemDTO] result = apiInstance.getReportListUsingGET1();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InlineXbrlRestControllerApi.getReportListUsingGET1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InlineXbrlRestControllerApi();

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

my $api_instance = WWW::SwaggerClient::InlineXbrlRestControllerApi->new();

eval { 
    my $result = $api_instance->getReportListUsingGET1();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InlineXbrlRestControllerApi->getReportListUsingGET1: $@\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.InlineXbrlRestControllerApi()

try: 
    # Get descriptors of all Inline XBRL reports in REST collection
    api_response = api_instance.get_report_list_using_get1()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InlineXbrlRestControllerApi->getReportListUsingGET1: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getReportRelatedFilesUsingGET1

Get all report related files


/inline-xbrl/reports/{id}/aux-files

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/inline-xbrl/reports/{id}/aux-files"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InlineXbrlRestControllerApi;

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

public class InlineXbrlRestControllerApiExample {

    public static void main(String[] args) {
        
        InlineXbrlRestControllerApi apiInstance = new InlineXbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            array[ReportRelatedFileDTO] result = apiInstance.getReportRelatedFilesUsingGET1(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlineXbrlRestControllerApi#getReportRelatedFilesUsingGET1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InlineXbrlRestControllerApi;

public class InlineXbrlRestControllerApiExample {

    public static void main(String[] args) {
        InlineXbrlRestControllerApi apiInstance = new InlineXbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            array[ReportRelatedFileDTO] result = apiInstance.getReportRelatedFilesUsingGET1(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlineXbrlRestControllerApi#getReportRelatedFilesUsingGET1");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Get all report related files
[apiInstance getReportRelatedFilesUsingGET1With:id
              completionHandler: ^(array[ReportRelatedFileDTO] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.InlineXbrlRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class getReportRelatedFilesUsingGET1Example
    {
        public void main()
        {
            
            var apiInstance = new InlineXbrlRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Get all report related files
                array[ReportRelatedFileDTO] result = apiInstance.getReportRelatedFilesUsingGET1(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InlineXbrlRestControllerApi.getReportRelatedFilesUsingGET1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InlineXbrlRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::InlineXbrlRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    my $result = $api_instance->getReportRelatedFilesUsingGET1(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InlineXbrlRestControllerApi->getReportRelatedFilesUsingGET1: $@\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.InlineXbrlRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Get all report related files
    api_response = api_instance.get_report_related_files_using_get1(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InlineXbrlRestControllerApi->getReportRelatedFilesUsingGET1: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


getReportUsingGET1

Get report descriptor


/inline-xbrl/reports/{id}

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/inline-xbrl/reports/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InlineXbrlRestControllerApi;

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

public class InlineXbrlRestControllerApiExample {

    public static void main(String[] args) {
        
        InlineXbrlRestControllerApi apiInstance = new InlineXbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            ReportItemDTO result = apiInstance.getReportUsingGET1(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlineXbrlRestControllerApi#getReportUsingGET1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InlineXbrlRestControllerApi;

public class InlineXbrlRestControllerApiExample {

    public static void main(String[] args) {
        InlineXbrlRestControllerApi apiInstance = new InlineXbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            ReportItemDTO result = apiInstance.getReportUsingGET1(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlineXbrlRestControllerApi#getReportUsingGET1");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Get report descriptor
[apiInstance getReportUsingGET1With:id
              completionHandler: ^(ReportItemDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.InlineXbrlRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class getReportUsingGET1Example
    {
        public void main()
        {
            
            var apiInstance = new InlineXbrlRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Get report descriptor
                ReportItemDTO result = apiInstance.getReportUsingGET1(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InlineXbrlRestControllerApi.getReportUsingGET1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InlineXbrlRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::InlineXbrlRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    my $result = $api_instance->getReportUsingGET1(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InlineXbrlRestControllerApi->getReportUsingGET1: $@\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.InlineXbrlRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Get report descriptor
    api_response = api_instance.get_report_using_get1(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InlineXbrlRestControllerApi->getReportUsingGET1: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist


insertReportUsingPOST1

Add Inline XBRL report to REST collection


/inline-xbrl/reports

Usage and SDK Samples

curl -X POST "https://localhost:8088/raportado-services/inline-xbrl/reports"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InlineXbrlRestControllerApi;

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

public class InlineXbrlRestControllerApiExample {

    public static void main(String[] args) {
        
        InlineXbrlRestControllerApi apiInstance = new InlineXbrlRestControllerApi();
        File file = /path/to/file.txt; // File | Inline XBRL report file
        try {
            Long result = apiInstance.insertReportUsingPOST1(file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlineXbrlRestControllerApi#insertReportUsingPOST1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InlineXbrlRestControllerApi;

public class InlineXbrlRestControllerApiExample {

    public static void main(String[] args) {
        InlineXbrlRestControllerApi apiInstance = new InlineXbrlRestControllerApi();
        File file = /path/to/file.txt; // File | Inline XBRL report file
        try {
            Long result = apiInstance.insertReportUsingPOST1(file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlineXbrlRestControllerApi#insertReportUsingPOST1");
            e.printStackTrace();
        }
    }
}
File *file = /path/to/file.txt; // Inline XBRL report file

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

// Add Inline XBRL report to REST collection
[apiInstance insertReportUsingPOST1With:file
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.InlineXbrlRestControllerApi()

var file = /path/to/file.txt; // {File} Inline XBRL report file


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

namespace Example
{
    public class insertReportUsingPOST1Example
    {
        public void main()
        {
            
            var apiInstance = new InlineXbrlRestControllerApi();
            var file = new File(); // File | Inline XBRL report file

            try
            {
                // Add Inline XBRL report to REST collection
                Long result = apiInstance.insertReportUsingPOST1(file);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InlineXbrlRestControllerApi.insertReportUsingPOST1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InlineXbrlRestControllerApi();
$file = /path/to/file.txt; // File | Inline XBRL report file

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

my $api_instance = WWW::SwaggerClient::InlineXbrlRestControllerApi->new();
my $file = /path/to/file.txt; # File | Inline XBRL report file

eval { 
    my $result = $api_instance->insertReportUsingPOST1(file => $file);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InlineXbrlRestControllerApi->insertReportUsingPOST1: $@\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.InlineXbrlRestControllerApi()
file = /path/to/file.txt # File | Inline XBRL report file

try: 
    # Add Inline XBRL report to REST collection
    api_response = api_instance.insert_report_using_post1(file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InlineXbrlRestControllerApi->insertReportUsingPOST1: %s\n" % e)

Parameters

Form parameters
Name Description
file*
File
Inline XBRL report file
Required

Responses

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Invalid File Format


validateUsingGET

Validate Inline XBRL raport against selected validation engines and return JSON document with validation results


/inline-xbrl/reports/{id}/validation-results

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/inline-xbrl/reports/{id}/validation-results?excludedAssertions=&excludedFilingRules=&validateDimensions=&validateFilingRules=&validateFormulas=&validateInlineXBRL=&validateXBRL="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InlineXbrlRestControllerApi;

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

public class InlineXbrlRestControllerApiExample {

    public static void main(String[] args) {
        
        InlineXbrlRestControllerApi apiInstance = new InlineXbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        String excludedAssertions = excludedAssertions_example; // String | List of Formula assertion IDs to be excluded
        String excludedFilingRules = excludedFilingRules_example; // String | List of filing rules IDs to be excluded
        Boolean validateDimensions = true; // Boolean | Switch ON/OFF dimensions validation
        Boolean validateFilingRules = true; // Boolean | Switch ON/OFF filing rules validation
        Boolean validateFormulas = true; // Boolean | Switch ON/OFF formula validation
        Boolean validateInlineXBRL = true; // Boolean | Switch ON/OFF Inline XBRL validation
        Boolean validateXBRL = true; // Boolean | Switch ON/OFF XBRL 2.1 validation
        try {
            RapValidationDataDTO result = apiInstance.validateUsingGET(id, excludedAssertions, excludedFilingRules, validateDimensions, validateFilingRules, validateFormulas, validateInlineXBRL, validateXBRL);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlineXbrlRestControllerApi#validateUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InlineXbrlRestControllerApi;

public class InlineXbrlRestControllerApiExample {

    public static void main(String[] args) {
        InlineXbrlRestControllerApi apiInstance = new InlineXbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        String excludedAssertions = excludedAssertions_example; // String | List of Formula assertion IDs to be excluded
        String excludedFilingRules = excludedFilingRules_example; // String | List of filing rules IDs to be excluded
        Boolean validateDimensions = true; // Boolean | Switch ON/OFF dimensions validation
        Boolean validateFilingRules = true; // Boolean | Switch ON/OFF filing rules validation
        Boolean validateFormulas = true; // Boolean | Switch ON/OFF formula validation
        Boolean validateInlineXBRL = true; // Boolean | Switch ON/OFF Inline XBRL validation
        Boolean validateXBRL = true; // Boolean | Switch ON/OFF XBRL 2.1 validation
        try {
            RapValidationDataDTO result = apiInstance.validateUsingGET(id, excludedAssertions, excludedFilingRules, validateDimensions, validateFilingRules, validateFormulas, validateInlineXBRL, validateXBRL);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlineXbrlRestControllerApi#validateUsingGET");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID
String *excludedAssertions = excludedAssertions_example; // List of Formula assertion IDs to be excluded (optional)
String *excludedFilingRules = excludedFilingRules_example; // List of filing rules IDs to be excluded (optional)
Boolean *validateDimensions = true; // Switch ON/OFF dimensions validation (optional)
Boolean *validateFilingRules = true; // Switch ON/OFF filing rules validation (optional)
Boolean *validateFormulas = true; // Switch ON/OFF formula validation (optional)
Boolean *validateInlineXBRL = true; // Switch ON/OFF Inline XBRL validation (optional)
Boolean *validateXBRL = true; // Switch ON/OFF XBRL 2.1 validation (optional)

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

// Validate Inline XBRL raport against selected validation engines and return JSON document with validation results
[apiInstance validateUsingGETWith:id
    excludedAssertions:excludedAssertions
    excludedFilingRules:excludedFilingRules
    validateDimensions:validateDimensions
    validateFilingRules:validateFilingRules
    validateFormulas:validateFormulas
    validateInlineXBRL:validateInlineXBRL
    validateXBRL:validateXBRL
              completionHandler: ^(RapValidationDataDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.InlineXbrlRestControllerApi()

var id = 789; // {Long} Report ID

var opts = { 
  'excludedAssertions': excludedAssertions_example, // {String} List of Formula assertion IDs to be excluded
  'excludedFilingRules': excludedFilingRules_example, // {String} List of filing rules IDs to be excluded
  'validateDimensions': true, // {Boolean} Switch ON/OFF dimensions validation
  'validateFilingRules': true, // {Boolean} Switch ON/OFF filing rules validation
  'validateFormulas': true, // {Boolean} Switch ON/OFF formula validation
  'validateInlineXBRL': true, // {Boolean} Switch ON/OFF Inline XBRL validation
  'validateXBRL': true // {Boolean} Switch ON/OFF XBRL 2.1 validation
};

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

namespace Example
{
    public class validateUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new InlineXbrlRestControllerApi();
            var id = 789;  // Long | Report ID
            var excludedAssertions = excludedAssertions_example;  // String | List of Formula assertion IDs to be excluded (optional) 
            var excludedFilingRules = excludedFilingRules_example;  // String | List of filing rules IDs to be excluded (optional) 
            var validateDimensions = true;  // Boolean | Switch ON/OFF dimensions validation (optional) 
            var validateFilingRules = true;  // Boolean | Switch ON/OFF filing rules validation (optional) 
            var validateFormulas = true;  // Boolean | Switch ON/OFF formula validation (optional) 
            var validateInlineXBRL = true;  // Boolean | Switch ON/OFF Inline XBRL validation (optional) 
            var validateXBRL = true;  // Boolean | Switch ON/OFF XBRL 2.1 validation (optional) 

            try
            {
                // Validate Inline XBRL raport against selected validation engines and return JSON document with validation results
                RapValidationDataDTO result = apiInstance.validateUsingGET(id, excludedAssertions, excludedFilingRules, validateDimensions, validateFilingRules, validateFormulas, validateInlineXBRL, validateXBRL);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InlineXbrlRestControllerApi.validateUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InlineXbrlRestControllerApi();
$id = 789; // Long | Report ID
$excludedAssertions = excludedAssertions_example; // String | List of Formula assertion IDs to be excluded
$excludedFilingRules = excludedFilingRules_example; // String | List of filing rules IDs to be excluded
$validateDimensions = true; // Boolean | Switch ON/OFF dimensions validation
$validateFilingRules = true; // Boolean | Switch ON/OFF filing rules validation
$validateFormulas = true; // Boolean | Switch ON/OFF formula validation
$validateInlineXBRL = true; // Boolean | Switch ON/OFF Inline XBRL validation
$validateXBRL = true; // Boolean | Switch ON/OFF XBRL 2.1 validation

try {
    $result = $api_instance->validateUsingGET($id, $excludedAssertions, $excludedFilingRules, $validateDimensions, $validateFilingRules, $validateFormulas, $validateInlineXBRL, $validateXBRL);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InlineXbrlRestControllerApi->validateUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InlineXbrlRestControllerApi;

my $api_instance = WWW::SwaggerClient::InlineXbrlRestControllerApi->new();
my $id = 789; # Long | Report ID
my $excludedAssertions = excludedAssertions_example; # String | List of Formula assertion IDs to be excluded
my $excludedFilingRules = excludedFilingRules_example; # String | List of filing rules IDs to be excluded
my $validateDimensions = true; # Boolean | Switch ON/OFF dimensions validation
my $validateFilingRules = true; # Boolean | Switch ON/OFF filing rules validation
my $validateFormulas = true; # Boolean | Switch ON/OFF formula validation
my $validateInlineXBRL = true; # Boolean | Switch ON/OFF Inline XBRL validation
my $validateXBRL = true; # Boolean | Switch ON/OFF XBRL 2.1 validation

eval { 
    my $result = $api_instance->validateUsingGET(id => $id, excludedAssertions => $excludedAssertions, excludedFilingRules => $excludedFilingRules, validateDimensions => $validateDimensions, validateFilingRules => $validateFilingRules, validateFormulas => $validateFormulas, validateInlineXBRL => $validateInlineXBRL, validateXBRL => $validateXBRL);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InlineXbrlRestControllerApi->validateUsingGET: $@\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.InlineXbrlRestControllerApi()
id = 789 # Long | Report ID
excludedAssertions = excludedAssertions_example # String | List of Formula assertion IDs to be excluded (optional)
excludedFilingRules = excludedFilingRules_example # String | List of filing rules IDs to be excluded (optional)
validateDimensions = true # Boolean | Switch ON/OFF dimensions validation (optional)
validateFilingRules = true # Boolean | Switch ON/OFF filing rules validation (optional)
validateFormulas = true # Boolean | Switch ON/OFF formula validation (optional)
validateInlineXBRL = true # Boolean | Switch ON/OFF Inline XBRL validation (optional)
validateXBRL = true # Boolean | Switch ON/OFF XBRL 2.1 validation (optional)

try: 
    # Validate Inline XBRL raport against selected validation engines and return JSON document with validation results
    api_response = api_instance.validate_using_get(id, excludedAssertions=excludedAssertions, excludedFilingRules=excludedFilingRules, validateDimensions=validateDimensions, validateFilingRules=validateFilingRules, validateFormulas=validateFormulas, validateInlineXBRL=validateInlineXBRL, validateXBRL=validateXBRL)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InlineXbrlRestControllerApi->validateUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required
Query parameters
Name Description
excludedAssertions
String
List of Formula assertion IDs to be excluded
excludedFilingRules
String
List of filing rules IDs to be excluded
validateDimensions
Boolean
Switch ON/OFF dimensions validation
validateFilingRules
Boolean
Switch ON/OFF filing rules validation
validateFormulas
Boolean
Switch ON/OFF formula validation
validateInlineXBRL
Boolean
Switch ON/OFF Inline XBRL validation
validateXBRL
Boolean
Switch ON/OFF XBRL 2.1 validation

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


StagingDbRestController

getInstanceListUsingGET

Get descriptors of all reports in StagingDB


/staging-db/reports

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/staging-db/reports"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StagingDbRestControllerApi;

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

public class StagingDbRestControllerApiExample {

    public static void main(String[] args) {
        
        StagingDbRestControllerApi apiInstance = new StagingDbRestControllerApi();
        try {
            array[Instance] result = apiInstance.getInstanceListUsingGET();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StagingDbRestControllerApi#getInstanceListUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StagingDbRestControllerApi;

public class StagingDbRestControllerApiExample {

    public static void main(String[] args) {
        StagingDbRestControllerApi apiInstance = new StagingDbRestControllerApi();
        try {
            array[Instance] result = apiInstance.getInstanceListUsingGET();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StagingDbRestControllerApi#getInstanceListUsingGET");
            e.printStackTrace();
        }
    }
}

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

// Get descriptors of all reports in StagingDB
[apiInstance getInstanceListUsingGETWithCompletionHandler: 
              ^(array[Instance] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.StagingDbRestControllerApi()

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

namespace Example
{
    public class getInstanceListUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new StagingDbRestControllerApi();

            try
            {
                // Get descriptors of all reports in StagingDB
                array[Instance] result = apiInstance.getInstanceListUsingGET();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StagingDbRestControllerApi.getInstanceListUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StagingDbRestControllerApi();

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

my $api_instance = WWW::SwaggerClient::StagingDbRestControllerApi->new();

eval { 
    my $result = $api_instance->getInstanceListUsingGET();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StagingDbRestControllerApi->getInstanceListUsingGET: $@\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.StagingDbRestControllerApi()

try: 
    # Get descriptors of all reports in StagingDB
    api_response = api_instance.get_instance_list_using_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StagingDbRestControllerApi->getInstanceListUsingGET: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getInstanceUsingGET

Get descriptor of the instance from StagingDB


/staging-db/reports/{instanceIdentifier}

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/staging-db/reports/{instanceIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StagingDbRestControllerApi;

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

public class StagingDbRestControllerApiExample {

    public static void main(String[] args) {
        
        StagingDbRestControllerApi apiInstance = new StagingDbRestControllerApi();
        String instanceIdentifier = instanceIdentifier_example; // String | Instance ID
        try {
            Instance result = apiInstance.getInstanceUsingGET(instanceIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StagingDbRestControllerApi#getInstanceUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StagingDbRestControllerApi;

public class StagingDbRestControllerApiExample {

    public static void main(String[] args) {
        StagingDbRestControllerApi apiInstance = new StagingDbRestControllerApi();
        String instanceIdentifier = instanceIdentifier_example; // String | Instance ID
        try {
            Instance result = apiInstance.getInstanceUsingGET(instanceIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StagingDbRestControllerApi#getInstanceUsingGET");
            e.printStackTrace();
        }
    }
}
String *instanceIdentifier = instanceIdentifier_example; // Instance ID

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

// Get descriptor of the instance from StagingDB
[apiInstance getInstanceUsingGETWith:instanceIdentifier
              completionHandler: ^(Instance output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.StagingDbRestControllerApi()

var instanceIdentifier = instanceIdentifier_example; // {String} Instance ID


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

namespace Example
{
    public class getInstanceUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new StagingDbRestControllerApi();
            var instanceIdentifier = instanceIdentifier_example;  // String | Instance ID

            try
            {
                // Get descriptor of the instance from StagingDB
                Instance result = apiInstance.getInstanceUsingGET(instanceIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StagingDbRestControllerApi.getInstanceUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StagingDbRestControllerApi();
$instanceIdentifier = instanceIdentifier_example; // String | Instance ID

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

my $api_instance = WWW::SwaggerClient::StagingDbRestControllerApi->new();
my $instanceIdentifier = instanceIdentifier_example; # String | Instance ID

eval { 
    my $result = $api_instance->getInstanceUsingGET(instanceIdentifier => $instanceIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StagingDbRestControllerApi->getInstanceUsingGET: $@\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.StagingDbRestControllerApi()
instanceIdentifier = instanceIdentifier_example # String | Instance ID

try: 
    # Get descriptor of the instance from StagingDB
    api_response = api_instance.get_instance_using_get(instanceIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StagingDbRestControllerApi->getInstanceUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
instanceIdentifier*
String
Instance ID
Required

Responses

Status: 200 - OK

Status: 400 - StagingDB exception

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist


getTaxonomyListUsingGET

Get descriptors of all taxonomies in StagingDB


/staging-db/taxonomies

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/staging-db/taxonomies"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StagingDbRestControllerApi;

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

public class StagingDbRestControllerApiExample {

    public static void main(String[] args) {
        
        StagingDbRestControllerApi apiInstance = new StagingDbRestControllerApi();
        try {
            array[Taxonomy] result = apiInstance.getTaxonomyListUsingGET();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StagingDbRestControllerApi#getTaxonomyListUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StagingDbRestControllerApi;

public class StagingDbRestControllerApiExample {

    public static void main(String[] args) {
        StagingDbRestControllerApi apiInstance = new StagingDbRestControllerApi();
        try {
            array[Taxonomy] result = apiInstance.getTaxonomyListUsingGET();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StagingDbRestControllerApi#getTaxonomyListUsingGET");
            e.printStackTrace();
        }
    }
}

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

// Get descriptors of all taxonomies in StagingDB
[apiInstance getTaxonomyListUsingGETWithCompletionHandler: 
              ^(array[Taxonomy] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.StagingDbRestControllerApi()

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

namespace Example
{
    public class getTaxonomyListUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new StagingDbRestControllerApi();

            try
            {
                // Get descriptors of all taxonomies in StagingDB
                array[Taxonomy] result = apiInstance.getTaxonomyListUsingGET();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StagingDbRestControllerApi.getTaxonomyListUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StagingDbRestControllerApi();

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

my $api_instance = WWW::SwaggerClient::StagingDbRestControllerApi->new();

eval { 
    my $result = $api_instance->getTaxonomyListUsingGET();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StagingDbRestControllerApi->getTaxonomyListUsingGET: $@\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.StagingDbRestControllerApi()

try: 
    # Get descriptors of all taxonomies in StagingDB
    api_response = api_instance.get_taxonomy_list_using_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StagingDbRestControllerApi->getTaxonomyListUsingGET: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getTaxonomyUsingGET

Get taxonomy descriptor


/staging-db/taxonomies/{taxonomyIdentifier}

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/staging-db/taxonomies/{taxonomyIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StagingDbRestControllerApi;

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

public class StagingDbRestControllerApiExample {

    public static void main(String[] args) {
        
        StagingDbRestControllerApi apiInstance = new StagingDbRestControllerApi();
        String taxonomyIdentifier = taxonomyIdentifier_example; // String | Taxonomy ID
        try {
            Taxonomy result = apiInstance.getTaxonomyUsingGET(taxonomyIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StagingDbRestControllerApi#getTaxonomyUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StagingDbRestControllerApi;

public class StagingDbRestControllerApiExample {

    public static void main(String[] args) {
        StagingDbRestControllerApi apiInstance = new StagingDbRestControllerApi();
        String taxonomyIdentifier = taxonomyIdentifier_example; // String | Taxonomy ID
        try {
            Taxonomy result = apiInstance.getTaxonomyUsingGET(taxonomyIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StagingDbRestControllerApi#getTaxonomyUsingGET");
            e.printStackTrace();
        }
    }
}
String *taxonomyIdentifier = taxonomyIdentifier_example; // Taxonomy ID

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

// Get taxonomy descriptor
[apiInstance getTaxonomyUsingGETWith:taxonomyIdentifier
              completionHandler: ^(Taxonomy output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.StagingDbRestControllerApi()

var taxonomyIdentifier = taxonomyIdentifier_example; // {String} Taxonomy ID


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

namespace Example
{
    public class getTaxonomyUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new StagingDbRestControllerApi();
            var taxonomyIdentifier = taxonomyIdentifier_example;  // String | Taxonomy ID

            try
            {
                // Get taxonomy descriptor
                Taxonomy result = apiInstance.getTaxonomyUsingGET(taxonomyIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StagingDbRestControllerApi.getTaxonomyUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StagingDbRestControllerApi();
$taxonomyIdentifier = taxonomyIdentifier_example; // String | Taxonomy ID

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

my $api_instance = WWW::SwaggerClient::StagingDbRestControllerApi->new();
my $taxonomyIdentifier = taxonomyIdentifier_example; # String | Taxonomy ID

eval { 
    my $result = $api_instance->getTaxonomyUsingGET(taxonomyIdentifier => $taxonomyIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StagingDbRestControllerApi->getTaxonomyUsingGET: $@\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.StagingDbRestControllerApi()
taxonomyIdentifier = taxonomyIdentifier_example # String | Taxonomy ID

try: 
    # Get taxonomy descriptor
    api_response = api_instance.get_taxonomy_using_get(taxonomyIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StagingDbRestControllerApi->getTaxonomyUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
taxonomyIdentifier*
String
Taxonomy ID
Required

Responses

Status: 200 - OK

Status: 400 - StagingDB exception

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist


removeInstanceUsingDELETE

Remove instance from Staging DB


/staging-db/reports/{instanceIdentifier}

Usage and SDK Samples

curl -X DELETE "https://localhost:8088/raportado-services/staging-db/reports/{instanceIdentifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StagingDbRestControllerApi;

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

public class StagingDbRestControllerApiExample {

    public static void main(String[] args) {
        
        StagingDbRestControllerApi apiInstance = new StagingDbRestControllerApi();
        String instanceIdentifier = instanceIdentifier_example; // String | Instance ID
        try {
            apiInstance.removeInstanceUsingDELETE(instanceIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling StagingDbRestControllerApi#removeInstanceUsingDELETE");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StagingDbRestControllerApi;

public class StagingDbRestControllerApiExample {

    public static void main(String[] args) {
        StagingDbRestControllerApi apiInstance = new StagingDbRestControllerApi();
        String instanceIdentifier = instanceIdentifier_example; // String | Instance ID
        try {
            apiInstance.removeInstanceUsingDELETE(instanceIdentifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling StagingDbRestControllerApi#removeInstanceUsingDELETE");
            e.printStackTrace();
        }
    }
}
String *instanceIdentifier = instanceIdentifier_example; // Instance ID

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

// Remove instance from Staging DB
[apiInstance removeInstanceUsingDELETEWith:instanceIdentifier
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.StagingDbRestControllerApi()

var instanceIdentifier = instanceIdentifier_example; // {String} Instance ID


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

namespace Example
{
    public class removeInstanceUsingDELETEExample
    {
        public void main()
        {
            
            var apiInstance = new StagingDbRestControllerApi();
            var instanceIdentifier = instanceIdentifier_example;  // String | Instance ID

            try
            {
                // Remove instance from Staging DB
                apiInstance.removeInstanceUsingDELETE(instanceIdentifier);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StagingDbRestControllerApi.removeInstanceUsingDELETE: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StagingDbRestControllerApi();
$instanceIdentifier = instanceIdentifier_example; // String | Instance ID

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

my $api_instance = WWW::SwaggerClient::StagingDbRestControllerApi->new();
my $instanceIdentifier = instanceIdentifier_example; # String | Instance ID

eval { 
    $api_instance->removeInstanceUsingDELETE(instanceIdentifier => $instanceIdentifier);
};
if ($@) {
    warn "Exception when calling StagingDbRestControllerApi->removeInstanceUsingDELETE: $@\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.StagingDbRestControllerApi()
instanceIdentifier = instanceIdentifier_example # String | Instance ID

try: 
    # Remove instance from Staging DB
    api_instance.remove_instance_using_delete(instanceIdentifier)
except ApiException as e:
    print("Exception when calling StagingDbRestControllerApi->removeInstanceUsingDELETE: %s\n" % e)

Parameters

Path parameters
Name Description
instanceIdentifier*
String
Instance ID
Required

Responses

Status: 204 - No Content

Status: 400 - StagingDB exception

Status: 401 - Unauthorized

Status: 403 - Forbidden


retrieveInstanceXBRLFileUsingGET

Retrieve isntance from StagingDB


/staging-db/reports/{instanceIdentifier}/xbrl-file

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/staging-db/reports/{instanceIdentifier}/xbrl-file"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StagingDbRestControllerApi;

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

public class StagingDbRestControllerApiExample {

    public static void main(String[] args) {
        
        StagingDbRestControllerApi apiInstance = new StagingDbRestControllerApi();
        String instanceIdentifier = instanceIdentifier_example; // String | Instance ID
        try {
            Resource result = apiInstance.retrieveInstanceXBRLFileUsingGET(instanceIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StagingDbRestControllerApi#retrieveInstanceXBRLFileUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StagingDbRestControllerApi;

public class StagingDbRestControllerApiExample {

    public static void main(String[] args) {
        StagingDbRestControllerApi apiInstance = new StagingDbRestControllerApi();
        String instanceIdentifier = instanceIdentifier_example; // String | Instance ID
        try {
            Resource result = apiInstance.retrieveInstanceXBRLFileUsingGET(instanceIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StagingDbRestControllerApi#retrieveInstanceXBRLFileUsingGET");
            e.printStackTrace();
        }
    }
}
String *instanceIdentifier = instanceIdentifier_example; // Instance ID

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

// Retrieve isntance from StagingDB
[apiInstance retrieveInstanceXBRLFileUsingGETWith:instanceIdentifier
              completionHandler: ^(Resource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.StagingDbRestControllerApi()

var instanceIdentifier = instanceIdentifier_example; // {String} Instance ID


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

namespace Example
{
    public class retrieveInstanceXBRLFileUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new StagingDbRestControllerApi();
            var instanceIdentifier = instanceIdentifier_example;  // String | Instance ID

            try
            {
                // Retrieve isntance from StagingDB
                Resource result = apiInstance.retrieveInstanceXBRLFileUsingGET(instanceIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StagingDbRestControllerApi.retrieveInstanceXBRLFileUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StagingDbRestControllerApi();
$instanceIdentifier = instanceIdentifier_example; // String | Instance ID

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

my $api_instance = WWW::SwaggerClient::StagingDbRestControllerApi->new();
my $instanceIdentifier = instanceIdentifier_example; # String | Instance ID

eval { 
    my $result = $api_instance->retrieveInstanceXBRLFileUsingGET(instanceIdentifier => $instanceIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StagingDbRestControllerApi->retrieveInstanceXBRLFileUsingGET: $@\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.StagingDbRestControllerApi()
instanceIdentifier = instanceIdentifier_example # String | Instance ID

try: 
    # Retrieve isntance from StagingDB
    api_response = api_instance.retrieve_instance_xbrl_file_using_get(instanceIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StagingDbRestControllerApi->retrieveInstanceXBRLFileUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
instanceIdentifier*
String
Instance ID
Required

Responses

Status: 200 - OK

Status: 400 - StagingDB exception

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


stageReportPackageUsingPOST

Stage instance and taxonomy to StagingDB


/staging-db/reports

Usage and SDK Samples

curl -X POST "https://localhost:8088/raportado-services/staging-db/reports?Instance Identifier=&Taxonomy Identifier="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StagingDbRestControllerApi;

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

public class StagingDbRestControllerApiExample {

    public static void main(String[] args) {
        
        StagingDbRestControllerApi apiInstance = new StagingDbRestControllerApi();
        String instance Identifier = instance Identifier_example; // String | Instance ID
        File report File = /path/to/file.txt; // File | Report file
        String taxonomy Identifier = taxonomy Identifier_example; // String | Taxonomy ID
        try {
            'String' result = apiInstance.stageReportPackageUsingPOST(instance Identifier, report File, taxonomy Identifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StagingDbRestControllerApi#stageReportPackageUsingPOST");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StagingDbRestControllerApi;

public class StagingDbRestControllerApiExample {

    public static void main(String[] args) {
        StagingDbRestControllerApi apiInstance = new StagingDbRestControllerApi();
        String instance Identifier = instance Identifier_example; // String | Instance ID
        File report File = /path/to/file.txt; // File | Report file
        String taxonomy Identifier = taxonomy Identifier_example; // String | Taxonomy ID
        try {
            'String' result = apiInstance.stageReportPackageUsingPOST(instance Identifier, report File, taxonomy Identifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StagingDbRestControllerApi#stageReportPackageUsingPOST");
            e.printStackTrace();
        }
    }
}
String *instance Identifier = instance Identifier_example; // Instance ID
File *report File = /path/to/file.txt; // Report file
String *taxonomy Identifier = taxonomy Identifier_example; // Taxonomy ID

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

// Stage instance and taxonomy to StagingDB
[apiInstance stageReportPackageUsingPOSTWith:instance Identifier
    report File:report File
    taxonomy Identifier:taxonomy Identifier
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.StagingDbRestControllerApi()

var instance Identifier = instance Identifier_example; // {String} Instance ID

var report File = /path/to/file.txt; // {File} Report file

var taxonomy Identifier = taxonomy Identifier_example; // {String} Taxonomy ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.stageReportPackageUsingPOST(instance Identifier, report File, taxonomy Identifier, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class stageReportPackageUsingPOSTExample
    {
        public void main()
        {
            
            var apiInstance = new StagingDbRestControllerApi();
            var instance Identifier = instance Identifier_example;  // String | Instance ID
            var report File = new File(); // File | Report file
            var taxonomy Identifier = taxonomy Identifier_example;  // String | Taxonomy ID

            try
            {
                // Stage instance and taxonomy to StagingDB
                'String' result = apiInstance.stageReportPackageUsingPOST(instance Identifier, report File, taxonomy Identifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StagingDbRestControllerApi.stageReportPackageUsingPOST: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StagingDbRestControllerApi();
$instance Identifier = instance Identifier_example; // String | Instance ID
$report File = /path/to/file.txt; // File | Report file
$taxonomy Identifier = taxonomy Identifier_example; // String | Taxonomy ID

try {
    $result = $api_instance->stageReportPackageUsingPOST($instance Identifier, $report File, $taxonomy Identifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StagingDbRestControllerApi->stageReportPackageUsingPOST: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StagingDbRestControllerApi;

my $api_instance = WWW::SwaggerClient::StagingDbRestControllerApi->new();
my $instance Identifier = instance Identifier_example; # String | Instance ID
my $report File = /path/to/file.txt; # File | Report file
my $taxonomy Identifier = taxonomy Identifier_example; # String | Taxonomy ID

eval { 
    my $result = $api_instance->stageReportPackageUsingPOST(instance Identifier => $instance Identifier, report File => $report File, taxonomy Identifier => $taxonomy Identifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StagingDbRestControllerApi->stageReportPackageUsingPOST: $@\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.StagingDbRestControllerApi()
instance Identifier = instance Identifier_example # String | Instance ID
report File = /path/to/file.txt # File | Report file
taxonomy Identifier = taxonomy Identifier_example # String | Taxonomy ID

try: 
    # Stage instance and taxonomy to StagingDB
    api_response = api_instance.stage_report_package_using_post(instance Identifier, report File, taxonomy Identifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StagingDbRestControllerApi->stageReportPackageUsingPOST: %s\n" % e)

Parameters

Form parameters
Name Description
Report File*
File
Report file
Required
Query parameters
Name Description
Instance Identifier*
String
Instance ID
Required
Taxonomy Identifier*
String
Taxonomy ID
Required

Responses

Status: 201 - Created

Status: 400 - StagingDB exception

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


TaxonomyExtractionController

getConceptToDimensionMapUsingGET

Get dimensions defined in the taxonomy for each concept


/taxonomy/definitionLink/concept-to-dimensions-map

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/taxonomy/definitionLink/concept-to-dimensions-map?entryPointURI=&esefReportId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxonomyExtractionControllerApi;

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

public class TaxonomyExtractionControllerApiExample {

    public static void main(String[] args) {
        
        TaxonomyExtractionControllerApi apiInstance = new TaxonomyExtractionControllerApi();
        String entryPointURI = entryPointURI_example; // String | Entry point URI
        Long esefReportId = 789; // Long | Report ID
        try {
            ConceptToDimensionMapDTO result = apiInstance.getConceptToDimensionMapUsingGET(entryPointURI, esefReportId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomyExtractionControllerApi#getConceptToDimensionMapUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxonomyExtractionControllerApi;

public class TaxonomyExtractionControllerApiExample {

    public static void main(String[] args) {
        TaxonomyExtractionControllerApi apiInstance = new TaxonomyExtractionControllerApi();
        String entryPointURI = entryPointURI_example; // String | Entry point URI
        Long esefReportId = 789; // Long | Report ID
        try {
            ConceptToDimensionMapDTO result = apiInstance.getConceptToDimensionMapUsingGET(entryPointURI, esefReportId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomyExtractionControllerApi#getConceptToDimensionMapUsingGET");
            e.printStackTrace();
        }
    }
}
String *entryPointURI = entryPointURI_example; // Entry point URI
Long *esefReportId = 789; // Report ID (optional) (default to -1)

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

// Get dimensions defined in the taxonomy for each concept
[apiInstance getConceptToDimensionMapUsingGETWith:entryPointURI
    esefReportId:esefReportId
              completionHandler: ^(ConceptToDimensionMapDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.TaxonomyExtractionControllerApi()

var entryPointURI = entryPointURI_example; // {String} Entry point URI

var opts = { 
  'esefReportId': 789 // {Long} Report ID
};

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

namespace Example
{
    public class getConceptToDimensionMapUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new TaxonomyExtractionControllerApi();
            var entryPointURI = entryPointURI_example;  // String | Entry point URI
            var esefReportId = 789;  // Long | Report ID (optional)  (default to -1)

            try
            {
                // Get dimensions defined in the taxonomy for each concept
                ConceptToDimensionMapDTO result = apiInstance.getConceptToDimensionMapUsingGET(entryPointURI, esefReportId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxonomyExtractionControllerApi.getConceptToDimensionMapUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxonomyExtractionControllerApi();
$entryPointURI = entryPointURI_example; // String | Entry point URI
$esefReportId = 789; // Long | Report ID

try {
    $result = $api_instance->getConceptToDimensionMapUsingGET($entryPointURI, $esefReportId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxonomyExtractionControllerApi->getConceptToDimensionMapUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TaxonomyExtractionControllerApi;

my $api_instance = WWW::SwaggerClient::TaxonomyExtractionControllerApi->new();
my $entryPointURI = entryPointURI_example; # String | Entry point URI
my $esefReportId = 789; # Long | Report ID

eval { 
    my $result = $api_instance->getConceptToDimensionMapUsingGET(entryPointURI => $entryPointURI, esefReportId => $esefReportId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaxonomyExtractionControllerApi->getConceptToDimensionMapUsingGET: $@\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.TaxonomyExtractionControllerApi()
entryPointURI = entryPointURI_example # String | Entry point URI
esefReportId = 789 # Long | Report ID (optional) (default to -1)

try: 
    # Get dimensions defined in the taxonomy for each concept
    api_response = api_instance.get_concept_to_dimension_map_using_get(entryPointURI, esefReportId=esefReportId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaxonomyExtractionControllerApi->getConceptToDimensionMapUsingGET: %s\n" % e)

Parameters

Query parameters
Name Description
entryPointURI*
String
Entry point URI
Required
esefReportId
Long (int64)
Report ID

Responses

Status: 200 - OK

Status: 400 - Taxonomy Extraction Exception

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


getLabelLinkMappingUsingGET

Get element QName to label mapping


/taxonomy/labelLink/elementQName-to-Label-map

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/taxonomy/labelLink/elementQName-to-Label-map?entryPointURI=&esefReportId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxonomyExtractionControllerApi;

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

public class TaxonomyExtractionControllerApiExample {

    public static void main(String[] args) {
        
        TaxonomyExtractionControllerApi apiInstance = new TaxonomyExtractionControllerApi();
        String entryPointURI = entryPointURI_example; // String | Entry point URI
        Long esefReportId = 789; // Long | Report ID
        try {
            map['String', 'String'] result = apiInstance.getLabelLinkMappingUsingGET(entryPointURI, esefReportId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomyExtractionControllerApi#getLabelLinkMappingUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxonomyExtractionControllerApi;

public class TaxonomyExtractionControllerApiExample {

    public static void main(String[] args) {
        TaxonomyExtractionControllerApi apiInstance = new TaxonomyExtractionControllerApi();
        String entryPointURI = entryPointURI_example; // String | Entry point URI
        Long esefReportId = 789; // Long | Report ID
        try {
            map['String', 'String'] result = apiInstance.getLabelLinkMappingUsingGET(entryPointURI, esefReportId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomyExtractionControllerApi#getLabelLinkMappingUsingGET");
            e.printStackTrace();
        }
    }
}
String *entryPointURI = entryPointURI_example; // Entry point URI
Long *esefReportId = 789; // Report ID (optional) (default to -1)

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

// Get element QName to label mapping
[apiInstance getLabelLinkMappingUsingGETWith:entryPointURI
    esefReportId:esefReportId
              completionHandler: ^(map['String', 'String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.TaxonomyExtractionControllerApi()

var entryPointURI = entryPointURI_example; // {String} Entry point URI

var opts = { 
  'esefReportId': 789 // {Long} Report ID
};

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

namespace Example
{
    public class getLabelLinkMappingUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new TaxonomyExtractionControllerApi();
            var entryPointURI = entryPointURI_example;  // String | Entry point URI
            var esefReportId = 789;  // Long | Report ID (optional)  (default to -1)

            try
            {
                // Get element QName to label mapping
                map['String', 'String'] result = apiInstance.getLabelLinkMappingUsingGET(entryPointURI, esefReportId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxonomyExtractionControllerApi.getLabelLinkMappingUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxonomyExtractionControllerApi();
$entryPointURI = entryPointURI_example; // String | Entry point URI
$esefReportId = 789; // Long | Report ID

try {
    $result = $api_instance->getLabelLinkMappingUsingGET($entryPointURI, $esefReportId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxonomyExtractionControllerApi->getLabelLinkMappingUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TaxonomyExtractionControllerApi;

my $api_instance = WWW::SwaggerClient::TaxonomyExtractionControllerApi->new();
my $entryPointURI = entryPointURI_example; # String | Entry point URI
my $esefReportId = 789; # Long | Report ID

eval { 
    my $result = $api_instance->getLabelLinkMappingUsingGET(entryPointURI => $entryPointURI, esefReportId => $esefReportId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaxonomyExtractionControllerApi->getLabelLinkMappingUsingGET: $@\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.TaxonomyExtractionControllerApi()
entryPointURI = entryPointURI_example # String | Entry point URI
esefReportId = 789 # Long | Report ID (optional) (default to -1)

try: 
    # Get element QName to label mapping
    api_response = api_instance.get_label_link_mapping_using_get(entryPointURI, esefReportId=esefReportId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaxonomyExtractionControllerApi->getLabelLinkMappingUsingGET: %s\n" % e)

Parameters

Query parameters
Name Description
entryPointURI*
String
Entry point URI
Required
esefReportId
Long (int64)
Report ID

Responses

Status: 200 - OK

Status: 400 - Taxonomy Extraction Exception

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


getPresentationLinkRoleToLabelMapUsingGET

Get role-to-lable map for presentation link


/taxonomy/presentationLink/role-to-Label-map

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/taxonomy/presentationLink/role-to-Label-map?entryPointURI=&esefReportId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxonomyExtractionControllerApi;

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

public class TaxonomyExtractionControllerApiExample {

    public static void main(String[] args) {
        
        TaxonomyExtractionControllerApi apiInstance = new TaxonomyExtractionControllerApi();
        String entryPointURI = entryPointURI_example; // String | Entry point URI
        Long esefReportId = 789; // Long | Report ID
        try {
            array[ValueLabelPair] result = apiInstance.getPresentationLinkRoleToLabelMapUsingGET(entryPointURI, esefReportId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomyExtractionControllerApi#getPresentationLinkRoleToLabelMapUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxonomyExtractionControllerApi;

public class TaxonomyExtractionControllerApiExample {

    public static void main(String[] args) {
        TaxonomyExtractionControllerApi apiInstance = new TaxonomyExtractionControllerApi();
        String entryPointURI = entryPointURI_example; // String | Entry point URI
        Long esefReportId = 789; // Long | Report ID
        try {
            array[ValueLabelPair] result = apiInstance.getPresentationLinkRoleToLabelMapUsingGET(entryPointURI, esefReportId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomyExtractionControllerApi#getPresentationLinkRoleToLabelMapUsingGET");
            e.printStackTrace();
        }
    }
}
String *entryPointURI = entryPointURI_example; // Entry point URI
Long *esefReportId = 789; // Report ID (optional) (default to -1)

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

// Get role-to-lable map for presentation link
[apiInstance getPresentationLinkRoleToLabelMapUsingGETWith:entryPointURI
    esefReportId:esefReportId
              completionHandler: ^(array[ValueLabelPair] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.TaxonomyExtractionControllerApi()

var entryPointURI = entryPointURI_example; // {String} Entry point URI

var opts = { 
  'esefReportId': 789 // {Long} Report ID
};

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

namespace Example
{
    public class getPresentationLinkRoleToLabelMapUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new TaxonomyExtractionControllerApi();
            var entryPointURI = entryPointURI_example;  // String | Entry point URI
            var esefReportId = 789;  // Long | Report ID (optional)  (default to -1)

            try
            {
                // Get role-to-lable map for presentation link
                array[ValueLabelPair] result = apiInstance.getPresentationLinkRoleToLabelMapUsingGET(entryPointURI, esefReportId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxonomyExtractionControllerApi.getPresentationLinkRoleToLabelMapUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxonomyExtractionControllerApi();
$entryPointURI = entryPointURI_example; // String | Entry point URI
$esefReportId = 789; // Long | Report ID

try {
    $result = $api_instance->getPresentationLinkRoleToLabelMapUsingGET($entryPointURI, $esefReportId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxonomyExtractionControllerApi->getPresentationLinkRoleToLabelMapUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TaxonomyExtractionControllerApi;

my $api_instance = WWW::SwaggerClient::TaxonomyExtractionControllerApi->new();
my $entryPointURI = entryPointURI_example; # String | Entry point URI
my $esefReportId = 789; # Long | Report ID

eval { 
    my $result = $api_instance->getPresentationLinkRoleToLabelMapUsingGET(entryPointURI => $entryPointURI, esefReportId => $esefReportId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaxonomyExtractionControllerApi->getPresentationLinkRoleToLabelMapUsingGET: $@\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.TaxonomyExtractionControllerApi()
entryPointURI = entryPointURI_example # String | Entry point URI
esefReportId = 789 # Long | Report ID (optional) (default to -1)

try: 
    # Get role-to-lable map for presentation link
    api_response = api_instance.get_presentation_link_role_to_label_map_using_get(entryPointURI, esefReportId=esefReportId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaxonomyExtractionControllerApi->getPresentationLinkRoleToLabelMapUsingGET: %s\n" % e)

Parameters

Query parameters
Name Description
entryPointURI*
String
Entry point URI
Required
esefReportId
Long (int64)
Report ID

Responses

Status: 200 - OK

Status: 400 - Taxonomy Extraction Exception

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


getPresentationLinkSetUsingGET

Get presentation link elements


/taxonomy/presentationLink/flat

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/taxonomy/presentationLink/flat?entryPointURI=&esefReportId=&roleURI="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxonomyExtractionControllerApi;

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

public class TaxonomyExtractionControllerApiExample {

    public static void main(String[] args) {
        
        TaxonomyExtractionControllerApi apiInstance = new TaxonomyExtractionControllerApi();
        String entryPointURI = entryPointURI_example; // String | Entry point URI
        Long esefReportId = 789; // Long | Report ID
        String roleURI = roleURI_example; // String | Role URI
        try {
            array[LinkElement] result = apiInstance.getPresentationLinkSetUsingGET(entryPointURI, esefReportId, roleURI);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomyExtractionControllerApi#getPresentationLinkSetUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxonomyExtractionControllerApi;

public class TaxonomyExtractionControllerApiExample {

    public static void main(String[] args) {
        TaxonomyExtractionControllerApi apiInstance = new TaxonomyExtractionControllerApi();
        String entryPointURI = entryPointURI_example; // String | Entry point URI
        Long esefReportId = 789; // Long | Report ID
        String roleURI = roleURI_example; // String | Role URI
        try {
            array[LinkElement] result = apiInstance.getPresentationLinkSetUsingGET(entryPointURI, esefReportId, roleURI);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomyExtractionControllerApi#getPresentationLinkSetUsingGET");
            e.printStackTrace();
        }
    }
}
String *entryPointURI = entryPointURI_example; // Entry point URI
Long *esefReportId = 789; // Report ID (optional) (default to -1)
String *roleURI = roleURI_example; // Role URI (optional)

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

// Get presentation link elements
[apiInstance getPresentationLinkSetUsingGETWith:entryPointURI
    esefReportId:esefReportId
    roleURI:roleURI
              completionHandler: ^(array[LinkElement] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.TaxonomyExtractionControllerApi()

var entryPointURI = entryPointURI_example; // {String} Entry point URI

var opts = { 
  'esefReportId': 789, // {Long} Report ID
  'roleURI': roleURI_example // {String} Role URI
};

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

namespace Example
{
    public class getPresentationLinkSetUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new TaxonomyExtractionControllerApi();
            var entryPointURI = entryPointURI_example;  // String | Entry point URI
            var esefReportId = 789;  // Long | Report ID (optional)  (default to -1)
            var roleURI = roleURI_example;  // String | Role URI (optional) 

            try
            {
                // Get presentation link elements
                array[LinkElement] result = apiInstance.getPresentationLinkSetUsingGET(entryPointURI, esefReportId, roleURI);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxonomyExtractionControllerApi.getPresentationLinkSetUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxonomyExtractionControllerApi();
$entryPointURI = entryPointURI_example; // String | Entry point URI
$esefReportId = 789; // Long | Report ID
$roleURI = roleURI_example; // String | Role URI

try {
    $result = $api_instance->getPresentationLinkSetUsingGET($entryPointURI, $esefReportId, $roleURI);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxonomyExtractionControllerApi->getPresentationLinkSetUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TaxonomyExtractionControllerApi;

my $api_instance = WWW::SwaggerClient::TaxonomyExtractionControllerApi->new();
my $entryPointURI = entryPointURI_example; # String | Entry point URI
my $esefReportId = 789; # Long | Report ID
my $roleURI = roleURI_example; # String | Role URI

eval { 
    my $result = $api_instance->getPresentationLinkSetUsingGET(entryPointURI => $entryPointURI, esefReportId => $esefReportId, roleURI => $roleURI);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaxonomyExtractionControllerApi->getPresentationLinkSetUsingGET: $@\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.TaxonomyExtractionControllerApi()
entryPointURI = entryPointURI_example # String | Entry point URI
esefReportId = 789 # Long | Report ID (optional) (default to -1)
roleURI = roleURI_example # String | Role URI (optional)

try: 
    # Get presentation link elements
    api_response = api_instance.get_presentation_link_set_using_get(entryPointURI, esefReportId=esefReportId, roleURI=roleURI)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaxonomyExtractionControllerApi->getPresentationLinkSetUsingGET: %s\n" % e)

Parameters

Query parameters
Name Description
entryPointURI*
String
Entry point URI
Required
esefReportId
Long (int64)
Report ID
roleURI
String
Role URI

Responses

Status: 200 - OK

Status: 400 - Taxonomy Extraction Exception

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


getPresentationLinkTreeUsingGET

Get presentation link tree


/taxonomy/presentationLink/tree

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/taxonomy/presentationLink/tree?entryPointURI=&esefReportId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxonomyExtractionControllerApi;

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

public class TaxonomyExtractionControllerApiExample {

    public static void main(String[] args) {
        
        TaxonomyExtractionControllerApi apiInstance = new TaxonomyExtractionControllerApi();
        String entryPointURI = entryPointURI_example; // String | Entry point URI
        Long esefReportId = 789; // Long | Report ID
        try {
            array[LinkContainer] result = apiInstance.getPresentationLinkTreeUsingGET(entryPointURI, esefReportId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomyExtractionControllerApi#getPresentationLinkTreeUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxonomyExtractionControllerApi;

public class TaxonomyExtractionControllerApiExample {

    public static void main(String[] args) {
        TaxonomyExtractionControllerApi apiInstance = new TaxonomyExtractionControllerApi();
        String entryPointURI = entryPointURI_example; // String | Entry point URI
        Long esefReportId = 789; // Long | Report ID
        try {
            array[LinkContainer] result = apiInstance.getPresentationLinkTreeUsingGET(entryPointURI, esefReportId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomyExtractionControllerApi#getPresentationLinkTreeUsingGET");
            e.printStackTrace();
        }
    }
}
String *entryPointURI = entryPointURI_example; // Entry point URI
Long *esefReportId = 789; // Report ID (optional) (default to -1)

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

// Get presentation link tree
[apiInstance getPresentationLinkTreeUsingGETWith:entryPointURI
    esefReportId:esefReportId
              completionHandler: ^(array[LinkContainer] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.TaxonomyExtractionControllerApi()

var entryPointURI = entryPointURI_example; // {String} Entry point URI

var opts = { 
  'esefReportId': 789 // {Long} Report ID
};

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

namespace Example
{
    public class getPresentationLinkTreeUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new TaxonomyExtractionControllerApi();
            var entryPointURI = entryPointURI_example;  // String | Entry point URI
            var esefReportId = 789;  // Long | Report ID (optional)  (default to -1)

            try
            {
                // Get presentation link tree
                array[LinkContainer] result = apiInstance.getPresentationLinkTreeUsingGET(entryPointURI, esefReportId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxonomyExtractionControllerApi.getPresentationLinkTreeUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxonomyExtractionControllerApi();
$entryPointURI = entryPointURI_example; // String | Entry point URI
$esefReportId = 789; // Long | Report ID

try {
    $result = $api_instance->getPresentationLinkTreeUsingGET($entryPointURI, $esefReportId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxonomyExtractionControllerApi->getPresentationLinkTreeUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TaxonomyExtractionControllerApi;

my $api_instance = WWW::SwaggerClient::TaxonomyExtractionControllerApi->new();
my $entryPointURI = entryPointURI_example; # String | Entry point URI
my $esefReportId = 789; # Long | Report ID

eval { 
    my $result = $api_instance->getPresentationLinkTreeUsingGET(entryPointURI => $entryPointURI, esefReportId => $esefReportId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaxonomyExtractionControllerApi->getPresentationLinkTreeUsingGET: $@\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.TaxonomyExtractionControllerApi()
entryPointURI = entryPointURI_example # String | Entry point URI
esefReportId = 789 # Long | Report ID (optional) (default to -1)

try: 
    # Get presentation link tree
    api_response = api_instance.get_presentation_link_tree_using_get(entryPointURI, esefReportId=esefReportId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaxonomyExtractionControllerApi->getPresentationLinkTreeUsingGET: %s\n" % e)

Parameters

Query parameters
Name Description
entryPointURI*
String
Entry point URI
Required
esefReportId
Long (int64)
Report ID

Responses

Status: 200 - OK

Status: 400 - Taxonomy Extraction Exception

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


TaxonomyPackageRestController

deleteTaxonomyUsingDELETE

Delete taxonomy from REST collection


/taxonomy/taxonomy-packages/{id}

Usage and SDK Samples

curl -X DELETE "https://localhost:8088/raportado-services/taxonomy/taxonomy-packages/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxonomyPackageRestControllerApi;

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

public class TaxonomyPackageRestControllerApiExample {

    public static void main(String[] args) {
        
        TaxonomyPackageRestControllerApi apiInstance = new TaxonomyPackageRestControllerApi();
        Long id = 789; // Long | Taxonomy ID
        try {
            apiInstance.deleteTaxonomyUsingDELETE(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomyPackageRestControllerApi#deleteTaxonomyUsingDELETE");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxonomyPackageRestControllerApi;

public class TaxonomyPackageRestControllerApiExample {

    public static void main(String[] args) {
        TaxonomyPackageRestControllerApi apiInstance = new TaxonomyPackageRestControllerApi();
        Long id = 789; // Long | Taxonomy ID
        try {
            apiInstance.deleteTaxonomyUsingDELETE(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomyPackageRestControllerApi#deleteTaxonomyUsingDELETE");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Taxonomy ID

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

// Delete taxonomy from REST collection
[apiInstance deleteTaxonomyUsingDELETEWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.TaxonomyPackageRestControllerApi()

var id = 789; // {Long} Taxonomy ID


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

namespace Example
{
    public class deleteTaxonomyUsingDELETEExample
    {
        public void main()
        {
            
            var apiInstance = new TaxonomyPackageRestControllerApi();
            var id = 789;  // Long | Taxonomy ID

            try
            {
                // Delete taxonomy from REST collection
                apiInstance.deleteTaxonomyUsingDELETE(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxonomyPackageRestControllerApi.deleteTaxonomyUsingDELETE: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxonomyPackageRestControllerApi();
$id = 789; // Long | Taxonomy ID

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

my $api_instance = WWW::SwaggerClient::TaxonomyPackageRestControllerApi->new();
my $id = 789; # Long | Taxonomy ID

eval { 
    $api_instance->deleteTaxonomyUsingDELETE(id => $id);
};
if ($@) {
    warn "Exception when calling TaxonomyPackageRestControllerApi->deleteTaxonomyUsingDELETE: $@\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.TaxonomyPackageRestControllerApi()
id = 789 # Long | Taxonomy ID

try: 
    # Delete taxonomy from REST collection
    api_instance.delete_taxonomy_using_delete(id)
except ApiException as e:
    print("Exception when calling TaxonomyPackageRestControllerApi->deleteTaxonomyUsingDELETE: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Taxonomy ID
Required

Responses

Status: 204 - No Content

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist


getTaxonomyListUsingGET1

Get descriptors of all taxonomy packages


/taxonomy/taxonomy-packages

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/taxonomy/taxonomy-packages"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxonomyPackageRestControllerApi;

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

public class TaxonomyPackageRestControllerApiExample {

    public static void main(String[] args) {
        
        TaxonomyPackageRestControllerApi apiInstance = new TaxonomyPackageRestControllerApi();
        try {
            array[TaxonomyDTO] result = apiInstance.getTaxonomyListUsingGET1();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomyPackageRestControllerApi#getTaxonomyListUsingGET1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxonomyPackageRestControllerApi;

public class TaxonomyPackageRestControllerApiExample {

    public static void main(String[] args) {
        TaxonomyPackageRestControllerApi apiInstance = new TaxonomyPackageRestControllerApi();
        try {
            array[TaxonomyDTO] result = apiInstance.getTaxonomyListUsingGET1();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomyPackageRestControllerApi#getTaxonomyListUsingGET1");
            e.printStackTrace();
        }
    }
}

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

// Get descriptors of all taxonomy packages
[apiInstance getTaxonomyListUsingGET1WithCompletionHandler: 
              ^(array[TaxonomyDTO] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.TaxonomyPackageRestControllerApi()

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

namespace Example
{
    public class getTaxonomyListUsingGET1Example
    {
        public void main()
        {
            
            var apiInstance = new TaxonomyPackageRestControllerApi();

            try
            {
                // Get descriptors of all taxonomy packages
                array[TaxonomyDTO] result = apiInstance.getTaxonomyListUsingGET1();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxonomyPackageRestControllerApi.getTaxonomyListUsingGET1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxonomyPackageRestControllerApi();

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

my $api_instance = WWW::SwaggerClient::TaxonomyPackageRestControllerApi->new();

eval { 
    my $result = $api_instance->getTaxonomyListUsingGET1();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaxonomyPackageRestControllerApi->getTaxonomyListUsingGET1: $@\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.TaxonomyPackageRestControllerApi()

try: 
    # Get descriptors of all taxonomy packages
    api_response = api_instance.get_taxonomy_list_using_get1()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaxonomyPackageRestControllerApi->getTaxonomyListUsingGET1: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getTaxonomyUsingGET1

Get descriptor of the taxonomy


/taxonomy/taxonomy-packages/{id}

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/taxonomy/taxonomy-packages/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxonomyPackageRestControllerApi;

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

public class TaxonomyPackageRestControllerApiExample {

    public static void main(String[] args) {
        
        TaxonomyPackageRestControllerApi apiInstance = new TaxonomyPackageRestControllerApi();
        Long id = 789; // Long | Taxonomy ID
        try {
            TaxonomyDTO result = apiInstance.getTaxonomyUsingGET1(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomyPackageRestControllerApi#getTaxonomyUsingGET1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxonomyPackageRestControllerApi;

public class TaxonomyPackageRestControllerApiExample {

    public static void main(String[] args) {
        TaxonomyPackageRestControllerApi apiInstance = new TaxonomyPackageRestControllerApi();
        Long id = 789; // Long | Taxonomy ID
        try {
            TaxonomyDTO result = apiInstance.getTaxonomyUsingGET1(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomyPackageRestControllerApi#getTaxonomyUsingGET1");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Taxonomy ID

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

// Get descriptor of the taxonomy
[apiInstance getTaxonomyUsingGET1With:id
              completionHandler: ^(TaxonomyDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.TaxonomyPackageRestControllerApi()

var id = 789; // {Long} Taxonomy ID


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

namespace Example
{
    public class getTaxonomyUsingGET1Example
    {
        public void main()
        {
            
            var apiInstance = new TaxonomyPackageRestControllerApi();
            var id = 789;  // Long | Taxonomy ID

            try
            {
                // Get descriptor of the taxonomy
                TaxonomyDTO result = apiInstance.getTaxonomyUsingGET1(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxonomyPackageRestControllerApi.getTaxonomyUsingGET1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxonomyPackageRestControllerApi();
$id = 789; // Long | Taxonomy ID

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

my $api_instance = WWW::SwaggerClient::TaxonomyPackageRestControllerApi->new();
my $id = 789; # Long | Taxonomy ID

eval { 
    my $result = $api_instance->getTaxonomyUsingGET1(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaxonomyPackageRestControllerApi->getTaxonomyUsingGET1: $@\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.TaxonomyPackageRestControllerApi()
id = 789 # Long | Taxonomy ID

try: 
    # Get descriptor of the taxonomy
    api_response = api_instance.get_taxonomy_using_get1(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaxonomyPackageRestControllerApi->getTaxonomyUsingGET1: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Taxonomy ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist


insertTaxonomyUsingPOST

Add XBRL taxonomy package to REST collection


/taxonomy/taxonomy-packages

Usage and SDK Samples

curl -X POST "https://localhost:8088/raportado-services/taxonomy/taxonomy-packages"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxonomyPackageRestControllerApi;

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

public class TaxonomyPackageRestControllerApiExample {

    public static void main(String[] args) {
        
        TaxonomyPackageRestControllerApi apiInstance = new TaxonomyPackageRestControllerApi();
        File file = /path/to/file.txt; // File | Taxonomy package file
        try {
            Long result = apiInstance.insertTaxonomyUsingPOST(file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomyPackageRestControllerApi#insertTaxonomyUsingPOST");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxonomyPackageRestControllerApi;

public class TaxonomyPackageRestControllerApiExample {

    public static void main(String[] args) {
        TaxonomyPackageRestControllerApi apiInstance = new TaxonomyPackageRestControllerApi();
        File file = /path/to/file.txt; // File | Taxonomy package file
        try {
            Long result = apiInstance.insertTaxonomyUsingPOST(file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomyPackageRestControllerApi#insertTaxonomyUsingPOST");
            e.printStackTrace();
        }
    }
}
File *file = /path/to/file.txt; // Taxonomy package file

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

// Add XBRL taxonomy package to REST collection
[apiInstance insertTaxonomyUsingPOSTWith:file
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.TaxonomyPackageRestControllerApi()

var file = /path/to/file.txt; // {File} Taxonomy package file


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

namespace Example
{
    public class insertTaxonomyUsingPOSTExample
    {
        public void main()
        {
            
            var apiInstance = new TaxonomyPackageRestControllerApi();
            var file = new File(); // File | Taxonomy package file

            try
            {
                // Add XBRL taxonomy package to REST collection
                Long result = apiInstance.insertTaxonomyUsingPOST(file);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxonomyPackageRestControllerApi.insertTaxonomyUsingPOST: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxonomyPackageRestControllerApi();
$file = /path/to/file.txt; // File | Taxonomy package file

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

my $api_instance = WWW::SwaggerClient::TaxonomyPackageRestControllerApi->new();
my $file = /path/to/file.txt; # File | Taxonomy package file

eval { 
    my $result = $api_instance->insertTaxonomyUsingPOST(file => $file);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaxonomyPackageRestControllerApi->insertTaxonomyUsingPOST: $@\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.TaxonomyPackageRestControllerApi()
file = /path/to/file.txt # File | Taxonomy package file

try: 
    # Add XBRL taxonomy package to REST collection
    api_response = api_instance.insert_taxonomy_using_post(file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaxonomyPackageRestControllerApi->insertTaxonomyUsingPOST: %s\n" % e)

Parameters

Form parameters
Name Description
file*
File
Taxonomy package file
Required

Responses

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Invalid File Format


validateUsingGET1

Validate taxonomy package and return JSON document with validation results


/taxonomy/taxonomy-packages/{id}/validation-results

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/taxonomy/taxonomy-packages/{id}/validation-results"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaxonomyPackageRestControllerApi;

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

public class TaxonomyPackageRestControllerApiExample {

    public static void main(String[] args) {
        
        TaxonomyPackageRestControllerApi apiInstance = new TaxonomyPackageRestControllerApi();
        Long id = 789; // Long | Taxonomy ID
        try {
            array[RapValidationResultDTO] result = apiInstance.validateUsingGET1(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomyPackageRestControllerApi#validateUsingGET1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaxonomyPackageRestControllerApi;

public class TaxonomyPackageRestControllerApiExample {

    public static void main(String[] args) {
        TaxonomyPackageRestControllerApi apiInstance = new TaxonomyPackageRestControllerApi();
        Long id = 789; // Long | Taxonomy ID
        try {
            array[RapValidationResultDTO] result = apiInstance.validateUsingGET1(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaxonomyPackageRestControllerApi#validateUsingGET1");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Taxonomy ID

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

// Validate taxonomy package and return JSON document with validation results
[apiInstance validateUsingGET1With:id
              completionHandler: ^(array[RapValidationResultDTO] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.TaxonomyPackageRestControllerApi()

var id = 789; // {Long} Taxonomy ID


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

namespace Example
{
    public class validateUsingGET1Example
    {
        public void main()
        {
            
            var apiInstance = new TaxonomyPackageRestControllerApi();
            var id = 789;  // Long | Taxonomy ID

            try
            {
                // Validate taxonomy package and return JSON document with validation results
                array[RapValidationResultDTO] result = apiInstance.validateUsingGET1(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaxonomyPackageRestControllerApi.validateUsingGET1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaxonomyPackageRestControllerApi();
$id = 789; // Long | Taxonomy ID

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

my $api_instance = WWW::SwaggerClient::TaxonomyPackageRestControllerApi->new();
my $id = 789; # Long | Taxonomy ID

eval { 
    my $result = $api_instance->validateUsingGET1(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TaxonomyPackageRestControllerApi->validateUsingGET1: $@\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.TaxonomyPackageRestControllerApi()
id = 789 # Long | Taxonomy ID

try: 
    # Validate taxonomy package and return JSON document with validation results
    api_response = api_instance.validate_using_get1(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaxonomyPackageRestControllerApi->validateUsingGET1: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Taxonomy ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


XWandQueryRestController

deleteQueryUsingDELETE

Delete query from REST collection


/xwand-query/{id}

Usage and SDK Samples

curl -X DELETE "https://localhost:8088/raportado-services/xwand-query/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XWandQueryRestControllerApi;

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

public class XWandQueryRestControllerApiExample {

    public static void main(String[] args) {
        
        XWandQueryRestControllerApi apiInstance = new XWandQueryRestControllerApi();
        Long id = 789; // Long | Query ID
        try {
            apiInstance.deleteQueryUsingDELETE(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling XWandQueryRestControllerApi#deleteQueryUsingDELETE");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XWandQueryRestControllerApi;

public class XWandQueryRestControllerApiExample {

    public static void main(String[] args) {
        XWandQueryRestControllerApi apiInstance = new XWandQueryRestControllerApi();
        Long id = 789; // Long | Query ID
        try {
            apiInstance.deleteQueryUsingDELETE(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling XWandQueryRestControllerApi#deleteQueryUsingDELETE");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Query ID

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

// Delete query from REST collection
[apiInstance deleteQueryUsingDELETEWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.XWandQueryRestControllerApi()

var id = 789; // {Long} Query ID


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

namespace Example
{
    public class deleteQueryUsingDELETEExample
    {
        public void main()
        {
            
            var apiInstance = new XWandQueryRestControllerApi();
            var id = 789;  // Long | Query ID

            try
            {
                // Delete query from REST collection
                apiInstance.deleteQueryUsingDELETE(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XWandQueryRestControllerApi.deleteQueryUsingDELETE: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\XWandQueryRestControllerApi();
$id = 789; // Long | Query ID

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

my $api_instance = WWW::SwaggerClient::XWandQueryRestControllerApi->new();
my $id = 789; # Long | Query ID

eval { 
    $api_instance->deleteQueryUsingDELETE(id => $id);
};
if ($@) {
    warn "Exception when calling XWandQueryRestControllerApi->deleteQueryUsingDELETE: $@\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.XWandQueryRestControllerApi()
id = 789 # Long | Query ID

try: 
    # Delete query from REST collection
    api_instance.delete_query_using_delete(id)
except ApiException as e:
    print("Exception when calling XWandQueryRestControllerApi->deleteQueryUsingDELETE: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Query ID
Required

Responses

Status: 204 - No Content

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist


getQueryListUsingGET

Get list of all queries


/xwand-query

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/xwand-query"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XWandQueryRestControllerApi;

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

public class XWandQueryRestControllerApiExample {

    public static void main(String[] args) {
        
        XWandQueryRestControllerApi apiInstance = new XWandQueryRestControllerApi();
        try {
            array[XwandQueryDTO] result = apiInstance.getQueryListUsingGET();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XWandQueryRestControllerApi#getQueryListUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XWandQueryRestControllerApi;

public class XWandQueryRestControllerApiExample {

    public static void main(String[] args) {
        XWandQueryRestControllerApi apiInstance = new XWandQueryRestControllerApi();
        try {
            array[XwandQueryDTO] result = apiInstance.getQueryListUsingGET();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XWandQueryRestControllerApi#getQueryListUsingGET");
            e.printStackTrace();
        }
    }
}

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

// Get list of all queries
[apiInstance getQueryListUsingGETWithCompletionHandler: 
              ^(array[XwandQueryDTO] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.XWandQueryRestControllerApi()

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

namespace Example
{
    public class getQueryListUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new XWandQueryRestControllerApi();

            try
            {
                // Get list of all queries
                array[XwandQueryDTO] result = apiInstance.getQueryListUsingGET();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XWandQueryRestControllerApi.getQueryListUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\XWandQueryRestControllerApi();

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

my $api_instance = WWW::SwaggerClient::XWandQueryRestControllerApi->new();

eval { 
    my $result = $api_instance->getQueryListUsingGET();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XWandQueryRestControllerApi->getQueryListUsingGET: $@\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.XWandQueryRestControllerApi()

try: 
    # Get list of all queries
    api_response = api_instance.get_query_list_using_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XWandQueryRestControllerApi->getQueryListUsingGET: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getXwandQueryUsingGET

Get XWand Query


/xwand-query/{id}

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/xwand-query/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XWandQueryRestControllerApi;

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

public class XWandQueryRestControllerApiExample {

    public static void main(String[] args) {
        
        XWandQueryRestControllerApi apiInstance = new XWandQueryRestControllerApi();
        Long id = 789; // Long | Query ID
        try {
            XwandQueryDTO result = apiInstance.getXwandQueryUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XWandQueryRestControllerApi#getXwandQueryUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XWandQueryRestControllerApi;

public class XWandQueryRestControllerApiExample {

    public static void main(String[] args) {
        XWandQueryRestControllerApi apiInstance = new XWandQueryRestControllerApi();
        Long id = 789; // Long | Query ID
        try {
            XwandQueryDTO result = apiInstance.getXwandQueryUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XWandQueryRestControllerApi#getXwandQueryUsingGET");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Query ID

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

// Get XWand Query
[apiInstance getXwandQueryUsingGETWith:id
              completionHandler: ^(XwandQueryDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.XWandQueryRestControllerApi()

var id = 789; // {Long} Query ID


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

namespace Example
{
    public class getXwandQueryUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new XWandQueryRestControllerApi();
            var id = 789;  // Long | Query ID

            try
            {
                // Get XWand Query
                XwandQueryDTO result = apiInstance.getXwandQueryUsingGET(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XWandQueryRestControllerApi.getXwandQueryUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\XWandQueryRestControllerApi();
$id = 789; // Long | Query ID

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

my $api_instance = WWW::SwaggerClient::XWandQueryRestControllerApi->new();
my $id = 789; # Long | Query ID

eval { 
    my $result = $api_instance->getXwandQueryUsingGET(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XWandQueryRestControllerApi->getXwandQueryUsingGET: $@\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.XWandQueryRestControllerApi()
id = 789 # Long | Query ID

try: 
    # Get XWand Query
    api_response = api_instance.get_xwand_query_using_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XWandQueryRestControllerApi->getXwandQueryUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Query ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Query Does Not Exist


submitQueryUsingPOST

Add XWand Query to REST collection


/xwand-query

Usage and SDK Samples

curl -X POST "https://localhost:8088/raportado-services/xwand-query"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XWandQueryRestControllerApi;

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

public class XWandQueryRestControllerApiExample {

    public static void main(String[] args) {
        
        XWandQueryRestControllerApi apiInstance = new XWandQueryRestControllerApi();
        XwandQueryRequest xwandQueryRequest = ; // XwandQueryRequest | XWand Query request
        try {
            Long result = apiInstance.submitQueryUsingPOST(xwandQueryRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XWandQueryRestControllerApi#submitQueryUsingPOST");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XWandQueryRestControllerApi;

public class XWandQueryRestControllerApiExample {

    public static void main(String[] args) {
        XWandQueryRestControllerApi apiInstance = new XWandQueryRestControllerApi();
        XwandQueryRequest xwandQueryRequest = ; // XwandQueryRequest | XWand Query request
        try {
            Long result = apiInstance.submitQueryUsingPOST(xwandQueryRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XWandQueryRestControllerApi#submitQueryUsingPOST");
            e.printStackTrace();
        }
    }
}
XwandQueryRequest *xwandQueryRequest = ; // XWand Query request

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

// Add XWand Query to REST collection
[apiInstance submitQueryUsingPOSTWith:xwandQueryRequest
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.XWandQueryRestControllerApi()

var xwandQueryRequest = ; // {XwandQueryRequest} XWand Query request


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

namespace Example
{
    public class submitQueryUsingPOSTExample
    {
        public void main()
        {
            
            var apiInstance = new XWandQueryRestControllerApi();
            var xwandQueryRequest = new XwandQueryRequest(); // XwandQueryRequest | XWand Query request

            try
            {
                // Add XWand Query to REST collection
                Long result = apiInstance.submitQueryUsingPOST(xwandQueryRequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XWandQueryRestControllerApi.submitQueryUsingPOST: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\XWandQueryRestControllerApi();
$xwandQueryRequest = ; // XwandQueryRequest | XWand Query request

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

my $api_instance = WWW::SwaggerClient::XWandQueryRestControllerApi->new();
my $xwandQueryRequest = WWW::SwaggerClient::Object::XwandQueryRequest->new(); # XwandQueryRequest | XWand Query request

eval { 
    my $result = $api_instance->submitQueryUsingPOST(xwandQueryRequest => $xwandQueryRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XWandQueryRestControllerApi->submitQueryUsingPOST: $@\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.XWandQueryRestControllerApi()
xwandQueryRequest =  # XwandQueryRequest | XWand Query request

try: 
    # Add XWand Query to REST collection
    api_response = api_instance.submit_query_using_post(xwandQueryRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XWandQueryRestControllerApi->submitQueryUsingPOST: %s\n" % e)

Parameters

Body parameters
Name Description
xwandQueryRequest *

Responses

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Invalid File Format


xwandQueryCsvUsingGET

Get results of the query in CSV document


/xwand-query/{id}/results-csv

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/xwand-query/{id}/results-csv"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XWandQueryRestControllerApi;

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

public class XWandQueryRestControllerApiExample {

    public static void main(String[] args) {
        
        XWandQueryRestControllerApi apiInstance = new XWandQueryRestControllerApi();
        Long id = 789; // Long | Query ID
        try {
            Object result = apiInstance.xwandQueryCsvUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XWandQueryRestControllerApi#xwandQueryCsvUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XWandQueryRestControllerApi;

public class XWandQueryRestControllerApiExample {

    public static void main(String[] args) {
        XWandQueryRestControllerApi apiInstance = new XWandQueryRestControllerApi();
        Long id = 789; // Long | Query ID
        try {
            Object result = apiInstance.xwandQueryCsvUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XWandQueryRestControllerApi#xwandQueryCsvUsingGET");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Query ID

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

// Get results of the query in CSV document
[apiInstance xwandQueryCsvUsingGETWith:id
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.XWandQueryRestControllerApi()

var id = 789; // {Long} Query ID


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

namespace Example
{
    public class xwandQueryCsvUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new XWandQueryRestControllerApi();
            var id = 789;  // Long | Query ID

            try
            {
                // Get results of the query in CSV document
                Object result = apiInstance.xwandQueryCsvUsingGET(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XWandQueryRestControllerApi.xwandQueryCsvUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\XWandQueryRestControllerApi();
$id = 789; // Long | Query ID

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

my $api_instance = WWW::SwaggerClient::XWandQueryRestControllerApi->new();
my $id = 789; # Long | Query ID

eval { 
    my $result = $api_instance->xwandQueryCsvUsingGET(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XWandQueryRestControllerApi->xwandQueryCsvUsingGET: $@\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.XWandQueryRestControllerApi()
id = 789 # Long | Query ID

try: 
    # Get results of the query in CSV document
    api_response = api_instance.xwand_query_csv_using_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XWandQueryRestControllerApi->xwandQueryCsvUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Query ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Query Does Not Exist


xwandQueryJsonUsingGET

Get resutls of the query in JSON document


/xwand-query/{id}/results-json

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/xwand-query/{id}/results-json"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XWandQueryRestControllerApi;

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

public class XWandQueryRestControllerApiExample {

    public static void main(String[] args) {
        
        XWandQueryRestControllerApi apiInstance = new XWandQueryRestControllerApi();
        Long id = 789; // Long | Query ID
        try {
            Object result = apiInstance.xwandQueryJsonUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XWandQueryRestControllerApi#xwandQueryJsonUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XWandQueryRestControllerApi;

public class XWandQueryRestControllerApiExample {

    public static void main(String[] args) {
        XWandQueryRestControllerApi apiInstance = new XWandQueryRestControllerApi();
        Long id = 789; // Long | Query ID
        try {
            Object result = apiInstance.xwandQueryJsonUsingGET(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XWandQueryRestControllerApi#xwandQueryJsonUsingGET");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Query ID

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

// Get resutls of the query in JSON document
[apiInstance xwandQueryJsonUsingGETWith:id
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.XWandQueryRestControllerApi()

var id = 789; // {Long} Query ID


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

namespace Example
{
    public class xwandQueryJsonUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new XWandQueryRestControllerApi();
            var id = 789;  // Long | Query ID

            try
            {
                // Get resutls of the query in JSON document
                Object result = apiInstance.xwandQueryJsonUsingGET(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XWandQueryRestControllerApi.xwandQueryJsonUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\XWandQueryRestControllerApi();
$id = 789; // Long | Query ID

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

my $api_instance = WWW::SwaggerClient::XWandQueryRestControllerApi->new();
my $id = 789; # Long | Query ID

eval { 
    my $result = $api_instance->xwandQueryJsonUsingGET(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XWandQueryRestControllerApi->xwandQueryJsonUsingGET: $@\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.XWandQueryRestControllerApi()
id = 789 # Long | Query ID

try: 
    # Get resutls of the query in JSON document
    api_response = api_instance.xwand_query_json_using_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XWandQueryRestControllerApi->xwandQueryJsonUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Query ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Query Does Not Exist


XbrlRestController

deleteReportUsingDELETE2

Delete report from REST collection


/xbrl/reports/{id}

Usage and SDK Samples

curl -X DELETE "https://localhost:8088/raportado-services/xbrl/reports/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XbrlRestControllerApi;

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

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            apiInstance.deleteReportUsingDELETE2(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#deleteReportUsingDELETE2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XbrlRestControllerApi;

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            apiInstance.deleteReportUsingDELETE2(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#deleteReportUsingDELETE2");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Delete report from REST collection
[apiInstance deleteReportUsingDELETE2With:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.XbrlRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class deleteReportUsingDELETE2Example
    {
        public void main()
        {
            
            var apiInstance = new XbrlRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Delete report from REST collection
                apiInstance.deleteReportUsingDELETE2(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XbrlRestControllerApi.deleteReportUsingDELETE2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\XbrlRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::XbrlRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    $api_instance->deleteReportUsingDELETE2(id => $id);
};
if ($@) {
    warn "Exception when calling XbrlRestControllerApi->deleteReportUsingDELETE2: $@\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.XbrlRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Delete report from REST collection
    api_instance.delete_report_using_delete2(id)
except ApiException as e:
    print("Exception when calling XbrlRestControllerApi->deleteReportUsingDELETE2: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 204 - No Content

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist


exportCSVUsingGET1

Export XBRL report to CSV document


/xbrl/reports/{id}/export-to-csv

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/xbrl/reports/{id}/export-to-csv?dataPointSpecification="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XbrlRestControllerApi;

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

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        Boolean dataPointSpecification = true; // Boolean | Whether data point specification should be included
        try {
            Resource result = apiInstance.exportCSVUsingGET1(id, dataPointSpecification);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#exportCSVUsingGET1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XbrlRestControllerApi;

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        Boolean dataPointSpecification = true; // Boolean | Whether data point specification should be included
        try {
            Resource result = apiInstance.exportCSVUsingGET1(id, dataPointSpecification);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#exportCSVUsingGET1");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID
Boolean *dataPointSpecification = true; // Whether data point specification should be included (optional) (default to false)

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

// Export XBRL report to CSV document
[apiInstance exportCSVUsingGET1With:id
    dataPointSpecification:dataPointSpecification
              completionHandler: ^(Resource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.XbrlRestControllerApi()

var id = 789; // {Long} Report ID

var opts = { 
  'dataPointSpecification': true // {Boolean} Whether data point specification should be included
};

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

namespace Example
{
    public class exportCSVUsingGET1Example
    {
        public void main()
        {
            
            var apiInstance = new XbrlRestControllerApi();
            var id = 789;  // Long | Report ID
            var dataPointSpecification = true;  // Boolean | Whether data point specification should be included (optional)  (default to false)

            try
            {
                // Export XBRL report to CSV document
                Resource result = apiInstance.exportCSVUsingGET1(id, dataPointSpecification);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XbrlRestControllerApi.exportCSVUsingGET1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\XbrlRestControllerApi();
$id = 789; // Long | Report ID
$dataPointSpecification = true; // Boolean | Whether data point specification should be included

try {
    $result = $api_instance->exportCSVUsingGET1($id, $dataPointSpecification);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XbrlRestControllerApi->exportCSVUsingGET1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XbrlRestControllerApi;

my $api_instance = WWW::SwaggerClient::XbrlRestControllerApi->new();
my $id = 789; # Long | Report ID
my $dataPointSpecification = true; # Boolean | Whether data point specification should be included

eval { 
    my $result = $api_instance->exportCSVUsingGET1(id => $id, dataPointSpecification => $dataPointSpecification);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XbrlRestControllerApi->exportCSVUsingGET1: $@\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.XbrlRestControllerApi()
id = 789 # Long | Report ID
dataPointSpecification = true # Boolean | Whether data point specification should be included (optional) (default to false)

try: 
    # Export XBRL report to CSV document
    api_response = api_instance.export_csv_using_get1(id, dataPointSpecification=dataPointSpecification)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XbrlRestControllerApi->exportCSVUsingGET1: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required
Query parameters
Name Description
dataPointSpecification
Boolean
Whether data point specification should be included

Responses

Status: 200 - OK

Status: 400 - Conversion Exception

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


exportJSONUsingGET2

Export XBRL report to JSON document


/xbrl/reports/{id}/export-to-json

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/xbrl/reports/{id}/export-to-json"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XbrlRestControllerApi;

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

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.exportJSONUsingGET2(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#exportJSONUsingGET2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XbrlRestControllerApi;

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.exportJSONUsingGET2(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#exportJSONUsingGET2");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Export XBRL report to JSON document
[apiInstance exportJSONUsingGET2With:id
              completionHandler: ^(Resource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.XbrlRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class exportJSONUsingGET2Example
    {
        public void main()
        {
            
            var apiInstance = new XbrlRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Export XBRL report to JSON document
                Resource result = apiInstance.exportJSONUsingGET2(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XbrlRestControllerApi.exportJSONUsingGET2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\XbrlRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::XbrlRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    my $result = $api_instance->exportJSONUsingGET2(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XbrlRestControllerApi->exportJSONUsingGET2: $@\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.XbrlRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Export XBRL report to JSON document
    api_response = api_instance.export_json_using_get2(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XbrlRestControllerApi->exportJSONUsingGET2: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


getOriginalFileUsingGET2

Get XBRL report file


/xbrl/reports/{id}/original-file

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/xbrl/reports/{id}/original-file"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XbrlRestControllerApi;

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

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.getOriginalFileUsingGET2(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#getOriginalFileUsingGET2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XbrlRestControllerApi;

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            Resource result = apiInstance.getOriginalFileUsingGET2(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#getOriginalFileUsingGET2");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Get XBRL report file
[apiInstance getOriginalFileUsingGET2With:id
              completionHandler: ^(Resource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.XbrlRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class getOriginalFileUsingGET2Example
    {
        public void main()
        {
            
            var apiInstance = new XbrlRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Get XBRL report file
                Resource result = apiInstance.getOriginalFileUsingGET2(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XbrlRestControllerApi.getOriginalFileUsingGET2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\XbrlRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::XbrlRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    my $result = $api_instance->getOriginalFileUsingGET2(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XbrlRestControllerApi->getOriginalFileUsingGET2: $@\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.XbrlRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Get XBRL report file
    api_response = api_instance.get_original_file_using_get2(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XbrlRestControllerApi->getOriginalFileUsingGET2: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist


getReportListUsingGET2

Get descriptors of all reports


/xbrl/reports

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/xbrl/reports"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XbrlRestControllerApi;

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

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        try {
            array[ReportItemDTO] result = apiInstance.getReportListUsingGET2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#getReportListUsingGET2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XbrlRestControllerApi;

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        try {
            array[ReportItemDTO] result = apiInstance.getReportListUsingGET2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#getReportListUsingGET2");
            e.printStackTrace();
        }
    }
}

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

// Get descriptors of all reports
[apiInstance getReportListUsingGET2WithCompletionHandler: 
              ^(array[ReportItemDTO] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.XbrlRestControllerApi()

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

namespace Example
{
    public class getReportListUsingGET2Example
    {
        public void main()
        {
            
            var apiInstance = new XbrlRestControllerApi();

            try
            {
                // Get descriptors of all reports
                array[ReportItemDTO] result = apiInstance.getReportListUsingGET2();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XbrlRestControllerApi.getReportListUsingGET2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\XbrlRestControllerApi();

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

my $api_instance = WWW::SwaggerClient::XbrlRestControllerApi->new();

eval { 
    my $result = $api_instance->getReportListUsingGET2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XbrlRestControllerApi->getReportListUsingGET2: $@\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.XbrlRestControllerApi()

try: 
    # Get descriptors of all reports
    api_response = api_instance.get_report_list_using_get2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XbrlRestControllerApi->getReportListUsingGET2: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getReportRelatedFilesUsingGET2

Get all report-related files


/xbrl/reports/{id}/aux-files

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/xbrl/reports/{id}/aux-files"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XbrlRestControllerApi;

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

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            array[ReportRelatedFileDTO] result = apiInstance.getReportRelatedFilesUsingGET2(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#getReportRelatedFilesUsingGET2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XbrlRestControllerApi;

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            array[ReportRelatedFileDTO] result = apiInstance.getReportRelatedFilesUsingGET2(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#getReportRelatedFilesUsingGET2");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Get all report-related files
[apiInstance getReportRelatedFilesUsingGET2With:id
              completionHandler: ^(array[ReportRelatedFileDTO] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.XbrlRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class getReportRelatedFilesUsingGET2Example
    {
        public void main()
        {
            
            var apiInstance = new XbrlRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Get all report-related files
                array[ReportRelatedFileDTO] result = apiInstance.getReportRelatedFilesUsingGET2(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XbrlRestControllerApi.getReportRelatedFilesUsingGET2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\XbrlRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::XbrlRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    my $result = $api_instance->getReportRelatedFilesUsingGET2(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XbrlRestControllerApi->getReportRelatedFilesUsingGET2: $@\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.XbrlRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Get all report-related files
    api_response = api_instance.get_report_related_files_using_get2(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XbrlRestControllerApi->getReportRelatedFilesUsingGET2: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


getReportUsingGET2

Get descriptor of the report


/xbrl/reports/{id}

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/xbrl/reports/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XbrlRestControllerApi;

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

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            ReportItemDTO result = apiInstance.getReportUsingGET2(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#getReportUsingGET2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XbrlRestControllerApi;

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        try {
            ReportItemDTO result = apiInstance.getReportUsingGET2(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#getReportUsingGET2");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID

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

// Get descriptor of the report
[apiInstance getReportUsingGET2With:id
              completionHandler: ^(ReportItemDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.XbrlRestControllerApi()

var id = 789; // {Long} Report ID


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

namespace Example
{
    public class getReportUsingGET2Example
    {
        public void main()
        {
            
            var apiInstance = new XbrlRestControllerApi();
            var id = 789;  // Long | Report ID

            try
            {
                // Get descriptor of the report
                ReportItemDTO result = apiInstance.getReportUsingGET2(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XbrlRestControllerApi.getReportUsingGET2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\XbrlRestControllerApi();
$id = 789; // Long | Report ID

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

my $api_instance = WWW::SwaggerClient::XbrlRestControllerApi->new();
my $id = 789; # Long | Report ID

eval { 
    my $result = $api_instance->getReportUsingGET2(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XbrlRestControllerApi->getReportUsingGET2: $@\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.XbrlRestControllerApi()
id = 789 # Long | Report ID

try: 
    # Get descriptor of the report
    api_response = api_instance.get_report_using_get2(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XbrlRestControllerApi->getReportUsingGET2: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist


importCSVUsingPOST

Import CSV document


/xbrl/reports/import-from-csv

Usage and SDK Samples

curl -X POST "https://localhost:8088/raportado-services/xbrl/reports/import-from-csv?desiredFilingIndicators=&forceSave=&reportedFilingIndicators="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XbrlRestControllerApi;

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

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        File configFile = /path/to/file.txt; // File | Configuration file
        File csvFile = /path/to/file.txt; // File | CSV file to be imported
        Boolean desiredFilingIndicators = true; // Boolean | Whether imported data should be filtered by filing indicators given in configuration file
        Boolean forceSave = true; // Boolean | Whether report saving should be forced
        Boolean reportedFilingIndicators = true; // Boolean | Whether imported data should be filtered by reported filing indicators
        try {
            Long result = apiInstance.importCSVUsingPOST(configFile, csvFile, desiredFilingIndicators, forceSave, reportedFilingIndicators);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#importCSVUsingPOST");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XbrlRestControllerApi;

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        File configFile = /path/to/file.txt; // File | Configuration file
        File csvFile = /path/to/file.txt; // File | CSV file to be imported
        Boolean desiredFilingIndicators = true; // Boolean | Whether imported data should be filtered by filing indicators given in configuration file
        Boolean forceSave = true; // Boolean | Whether report saving should be forced
        Boolean reportedFilingIndicators = true; // Boolean | Whether imported data should be filtered by reported filing indicators
        try {
            Long result = apiInstance.importCSVUsingPOST(configFile, csvFile, desiredFilingIndicators, forceSave, reportedFilingIndicators);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#importCSVUsingPOST");
            e.printStackTrace();
        }
    }
}
File *configFile = /path/to/file.txt; // Configuration file
File *csvFile = /path/to/file.txt; // CSV file to be imported
Boolean *desiredFilingIndicators = true; // Whether imported data should be filtered by filing indicators given in configuration file (optional)
Boolean *forceSave = true; // Whether report saving should be forced (optional)
Boolean *reportedFilingIndicators = true; // Whether imported data should be filtered by reported filing indicators (optional)

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

// Import CSV document
[apiInstance importCSVUsingPOSTWith:configFile
    csvFile:csvFile
    desiredFilingIndicators:desiredFilingIndicators
    forceSave:forceSave
    reportedFilingIndicators:reportedFilingIndicators
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.XbrlRestControllerApi()

var configFile = /path/to/file.txt; // {File} Configuration file

var csvFile = /path/to/file.txt; // {File} CSV file to be imported

var opts = { 
  'desiredFilingIndicators': true, // {Boolean} Whether imported data should be filtered by filing indicators given in configuration file
  'forceSave': true, // {Boolean} Whether report saving should be forced
  'reportedFilingIndicators': true // {Boolean} Whether imported data should be filtered by reported filing indicators
};

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

namespace Example
{
    public class importCSVUsingPOSTExample
    {
        public void main()
        {
            
            var apiInstance = new XbrlRestControllerApi();
            var configFile = new File(); // File | Configuration file
            var csvFile = new File(); // File | CSV file to be imported
            var desiredFilingIndicators = true;  // Boolean | Whether imported data should be filtered by filing indicators given in configuration file (optional) 
            var forceSave = true;  // Boolean | Whether report saving should be forced (optional) 
            var reportedFilingIndicators = true;  // Boolean | Whether imported data should be filtered by reported filing indicators (optional) 

            try
            {
                // Import CSV document
                Long result = apiInstance.importCSVUsingPOST(configFile, csvFile, desiredFilingIndicators, forceSave, reportedFilingIndicators);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XbrlRestControllerApi.importCSVUsingPOST: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\XbrlRestControllerApi();
$configFile = /path/to/file.txt; // File | Configuration file
$csvFile = /path/to/file.txt; // File | CSV file to be imported
$desiredFilingIndicators = true; // Boolean | Whether imported data should be filtered by filing indicators given in configuration file
$forceSave = true; // Boolean | Whether report saving should be forced
$reportedFilingIndicators = true; // Boolean | Whether imported data should be filtered by reported filing indicators

try {
    $result = $api_instance->importCSVUsingPOST($configFile, $csvFile, $desiredFilingIndicators, $forceSave, $reportedFilingIndicators);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XbrlRestControllerApi->importCSVUsingPOST: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XbrlRestControllerApi;

my $api_instance = WWW::SwaggerClient::XbrlRestControllerApi->new();
my $configFile = /path/to/file.txt; # File | Configuration file
my $csvFile = /path/to/file.txt; # File | CSV file to be imported
my $desiredFilingIndicators = true; # Boolean | Whether imported data should be filtered by filing indicators given in configuration file
my $forceSave = true; # Boolean | Whether report saving should be forced
my $reportedFilingIndicators = true; # Boolean | Whether imported data should be filtered by reported filing indicators

eval { 
    my $result = $api_instance->importCSVUsingPOST(configFile => $configFile, csvFile => $csvFile, desiredFilingIndicators => $desiredFilingIndicators, forceSave => $forceSave, reportedFilingIndicators => $reportedFilingIndicators);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XbrlRestControllerApi->importCSVUsingPOST: $@\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.XbrlRestControllerApi()
configFile = /path/to/file.txt # File | Configuration file
csvFile = /path/to/file.txt # File | CSV file to be imported
desiredFilingIndicators = true # Boolean | Whether imported data should be filtered by filing indicators given in configuration file (optional)
forceSave = true # Boolean | Whether report saving should be forced (optional)
reportedFilingIndicators = true # Boolean | Whether imported data should be filtered by reported filing indicators (optional)

try: 
    # Import CSV document
    api_response = api_instance.import_csv_using_post(configFile, csvFile, desiredFilingIndicators=desiredFilingIndicators, forceSave=forceSave, reportedFilingIndicators=reportedFilingIndicators)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XbrlRestControllerApi->importCSVUsingPOST: %s\n" % e)

Parameters

Form parameters
Name Description
configFile*
File
Configuration file
Required
csvFile*
File
CSV file to be imported
Required
Query parameters
Name Description
desiredFilingIndicators
Boolean
Whether imported data should be filtered by filing indicators given in configuration file
forceSave
Boolean
Whether report saving should be forced
reportedFilingIndicators
Boolean
Whether imported data should be filtered by reported filing indicators

Responses

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Invalid File Format


importExcelUsingPOST

Import Excel document


/xbrl/reports/import-from-excel

Usage and SDK Samples

curl -X POST "https://localhost:8088/raportado-services/xbrl/reports/import-from-excel?entryPointURI="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XbrlRestControllerApi;

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

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        String entryPointURI = entryPointURI_example; // String | Entry point URI
        File excelFile = /path/to/file.txt; // File | Excel document to be imported
        try {
            Long result = apiInstance.importExcelUsingPOST(entryPointURI, excelFile);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#importExcelUsingPOST");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XbrlRestControllerApi;

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        String entryPointURI = entryPointURI_example; // String | Entry point URI
        File excelFile = /path/to/file.txt; // File | Excel document to be imported
        try {
            Long result = apiInstance.importExcelUsingPOST(entryPointURI, excelFile);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#importExcelUsingPOST");
            e.printStackTrace();
        }
    }
}
String *entryPointURI = entryPointURI_example; // Entry point URI
File *excelFile = /path/to/file.txt; // Excel document to be imported

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

// Import Excel document
[apiInstance importExcelUsingPOSTWith:entryPointURI
    excelFile:excelFile
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.XbrlRestControllerApi()

var entryPointURI = entryPointURI_example; // {String} Entry point URI

var excelFile = /path/to/file.txt; // {File} Excel document to be imported


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

namespace Example
{
    public class importExcelUsingPOSTExample
    {
        public void main()
        {
            
            var apiInstance = new XbrlRestControllerApi();
            var entryPointURI = entryPointURI_example;  // String | Entry point URI
            var excelFile = new File(); // File | Excel document to be imported

            try
            {
                // Import Excel document
                Long result = apiInstance.importExcelUsingPOST(entryPointURI, excelFile);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XbrlRestControllerApi.importExcelUsingPOST: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\XbrlRestControllerApi();
$entryPointURI = entryPointURI_example; // String | Entry point URI
$excelFile = /path/to/file.txt; // File | Excel document to be imported

try {
    $result = $api_instance->importExcelUsingPOST($entryPointURI, $excelFile);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XbrlRestControllerApi->importExcelUsingPOST: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XbrlRestControllerApi;

my $api_instance = WWW::SwaggerClient::XbrlRestControllerApi->new();
my $entryPointURI = entryPointURI_example; # String | Entry point URI
my $excelFile = /path/to/file.txt; # File | Excel document to be imported

eval { 
    my $result = $api_instance->importExcelUsingPOST(entryPointURI => $entryPointURI, excelFile => $excelFile);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XbrlRestControllerApi->importExcelUsingPOST: $@\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.XbrlRestControllerApi()
entryPointURI = entryPointURI_example # String | Entry point URI
excelFile = /path/to/file.txt # File | Excel document to be imported

try: 
    # Import Excel document
    api_response = api_instance.import_excel_using_post(entryPointURI, excelFile)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XbrlRestControllerApi->importExcelUsingPOST: %s\n" % e)

Parameters

Form parameters
Name Description
excelFile*
File
Excel document to be imported
Required
Query parameters
Name Description
entryPointURI*
String
Entry point URI
Required

Responses

Status: 200 - OK

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Invalid File Format


insertReportUsingPOST2

Add XBRL file to REST collection


/xbrl/reports

Usage and SDK Samples

curl -X POST "https://localhost:8088/raportado-services/xbrl/reports"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XbrlRestControllerApi;

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

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        File file = /path/to/file.txt; // File | Report file
        try {
            Long result = apiInstance.insertReportUsingPOST2(file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#insertReportUsingPOST2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XbrlRestControllerApi;

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        File file = /path/to/file.txt; // File | Report file
        try {
            Long result = apiInstance.insertReportUsingPOST2(file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#insertReportUsingPOST2");
            e.printStackTrace();
        }
    }
}
File *file = /path/to/file.txt; // Report file

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

// Add XBRL file to REST collection
[apiInstance insertReportUsingPOST2With:file
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.XbrlRestControllerApi()

var file = /path/to/file.txt; // {File} Report file


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

namespace Example
{
    public class insertReportUsingPOST2Example
    {
        public void main()
        {
            
            var apiInstance = new XbrlRestControllerApi();
            var file = new File(); // File | Report file

            try
            {
                // Add XBRL file to REST collection
                Long result = apiInstance.insertReportUsingPOST2(file);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XbrlRestControllerApi.insertReportUsingPOST2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\XbrlRestControllerApi();
$file = /path/to/file.txt; // File | Report file

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

my $api_instance = WWW::SwaggerClient::XbrlRestControllerApi->new();
my $file = /path/to/file.txt; # File | Report file

eval { 
    my $result = $api_instance->insertReportUsingPOST2(file => $file);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XbrlRestControllerApi->insertReportUsingPOST2: $@\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.XbrlRestControllerApi()
file = /path/to/file.txt # File | Report file

try: 
    # Add XBRL file to REST collection
    api_response = api_instance.insert_report_using_post2(file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XbrlRestControllerApi->insertReportUsingPOST2: %s\n" % e)

Parameters

Form parameters
Name Description
file*
File
Report file
Required

Responses

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 422 - Invalid File Format


renderToExcelFileUsingGET

Render report content to Excel document


/xbrl/reports/{id}/render-to-excel

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/xbrl/reports/{id}/render-to-excel?includeValidationResults=&replaceMembersWithLabels="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XbrlRestControllerApi;

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

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        Boolean includeValidationResults = true; // Boolean | Whether output Excel should contain validation results
        Boolean replaceMembersWithLabels = true; // Boolean | Whether QNames should be replaces with their labels
        try {
            Resource result = apiInstance.renderToExcelFileUsingGET(id, includeValidationResults, replaceMembersWithLabels);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#renderToExcelFileUsingGET");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XbrlRestControllerApi;

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        Boolean includeValidationResults = true; // Boolean | Whether output Excel should contain validation results
        Boolean replaceMembersWithLabels = true; // Boolean | Whether QNames should be replaces with their labels
        try {
            Resource result = apiInstance.renderToExcelFileUsingGET(id, includeValidationResults, replaceMembersWithLabels);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#renderToExcelFileUsingGET");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID
Boolean *includeValidationResults = true; // Whether output Excel should contain validation results (optional) (default to true)
Boolean *replaceMembersWithLabels = true; // Whether QNames should be replaces with their labels (optional) (default to true)

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

// Render report content to Excel document
[apiInstance renderToExcelFileUsingGETWith:id
    includeValidationResults:includeValidationResults
    replaceMembersWithLabels:replaceMembersWithLabels
              completionHandler: ^(Resource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.XbrlRestControllerApi()

var id = 789; // {Long} Report ID

var opts = { 
  'includeValidationResults': true, // {Boolean} Whether output Excel should contain validation results
  'replaceMembersWithLabels': true // {Boolean} Whether QNames should be replaces with their labels
};

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

namespace Example
{
    public class renderToExcelFileUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new XbrlRestControllerApi();
            var id = 789;  // Long | Report ID
            var includeValidationResults = true;  // Boolean | Whether output Excel should contain validation results (optional)  (default to true)
            var replaceMembersWithLabels = true;  // Boolean | Whether QNames should be replaces with their labels (optional)  (default to true)

            try
            {
                // Render report content to Excel document
                Resource result = apiInstance.renderToExcelFileUsingGET(id, includeValidationResults, replaceMembersWithLabels);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XbrlRestControllerApi.renderToExcelFileUsingGET: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\XbrlRestControllerApi();
$id = 789; // Long | Report ID
$includeValidationResults = true; // Boolean | Whether output Excel should contain validation results
$replaceMembersWithLabels = true; // Boolean | Whether QNames should be replaces with their labels

try {
    $result = $api_instance->renderToExcelFileUsingGET($id, $includeValidationResults, $replaceMembersWithLabels);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XbrlRestControllerApi->renderToExcelFileUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XbrlRestControllerApi;

my $api_instance = WWW::SwaggerClient::XbrlRestControllerApi->new();
my $id = 789; # Long | Report ID
my $includeValidationResults = true; # Boolean | Whether output Excel should contain validation results
my $replaceMembersWithLabels = true; # Boolean | Whether QNames should be replaces with their labels

eval { 
    my $result = $api_instance->renderToExcelFileUsingGET(id => $id, includeValidationResults => $includeValidationResults, replaceMembersWithLabels => $replaceMembersWithLabels);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XbrlRestControllerApi->renderToExcelFileUsingGET: $@\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.XbrlRestControllerApi()
id = 789 # Long | Report ID
includeValidationResults = true # Boolean | Whether output Excel should contain validation results (optional) (default to true)
replaceMembersWithLabels = true # Boolean | Whether QNames should be replaces with their labels (optional) (default to true)

try: 
    # Render report content to Excel document
    api_response = api_instance.render_to_excel_file_using_get(id, includeValidationResults=includeValidationResults, replaceMembersWithLabels=replaceMembersWithLabels)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XbrlRestControllerApi->renderToExcelFileUsingGET: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required
Query parameters
Name Description
includeValidationResults
Boolean
Whether output Excel should contain validation results
replaceMembersWithLabels
Boolean
Whether QNames should be replaces with their labels

Responses

Status: 200 - OK

Status: 400 - Validation or Rendering Exception

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format


validateUsingGET2

Validate XBRL report against selected validation engines


/xbrl/reports/{id}/validation-results

Usage and SDK Samples

curl -X GET "https://localhost:8088/raportado-services/xbrl/reports/{id}/validation-results?excludedAssertions=&excludedFilingRules=&validateDimensions=&validateFilingRules=&validateFormulas=&validateXBRL="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.XbrlRestControllerApi;

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

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        String excludedAssertions = excludedAssertions_example; // String | List of Formula assertion IDs to be excluded
        String excludedFilingRules = excludedFilingRules_example; // String | List of filing rules IDs to be excluded
        Boolean validateDimensions = true; // Boolean | Switch ON/OFF dimensions validation
        Boolean validateFilingRules = true; // Boolean | Switch ON/OFF filing rules validation
        Boolean validateFormulas = true; // Boolean | Switch ON/OFF formula validation
        Boolean validateXBRL = true; // Boolean | Switch ON/OFF XBRL 2.1 validation
        try {
            RapValidationDataDTO result = apiInstance.validateUsingGET2(id, excludedAssertions, excludedFilingRules, validateDimensions, validateFilingRules, validateFormulas, validateXBRL);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#validateUsingGET2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.XbrlRestControllerApi;

public class XbrlRestControllerApiExample {

    public static void main(String[] args) {
        XbrlRestControllerApi apiInstance = new XbrlRestControllerApi();
        Long id = 789; // Long | Report ID
        String excludedAssertions = excludedAssertions_example; // String | List of Formula assertion IDs to be excluded
        String excludedFilingRules = excludedFilingRules_example; // String | List of filing rules IDs to be excluded
        Boolean validateDimensions = true; // Boolean | Switch ON/OFF dimensions validation
        Boolean validateFilingRules = true; // Boolean | Switch ON/OFF filing rules validation
        Boolean validateFormulas = true; // Boolean | Switch ON/OFF formula validation
        Boolean validateXBRL = true; // Boolean | Switch ON/OFF XBRL 2.1 validation
        try {
            RapValidationDataDTO result = apiInstance.validateUsingGET2(id, excludedAssertions, excludedFilingRules, validateDimensions, validateFilingRules, validateFormulas, validateXBRL);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling XbrlRestControllerApi#validateUsingGET2");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // Report ID
String *excludedAssertions = excludedAssertions_example; // List of Formula assertion IDs to be excluded (optional)
String *excludedFilingRules = excludedFilingRules_example; // List of filing rules IDs to be excluded (optional)
Boolean *validateDimensions = true; // Switch ON/OFF dimensions validation (optional)
Boolean *validateFilingRules = true; // Switch ON/OFF filing rules validation (optional)
Boolean *validateFormulas = true; // Switch ON/OFF formula validation (optional)
Boolean *validateXBRL = true; // Switch ON/OFF XBRL 2.1 validation (optional)

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

// Validate XBRL report against selected validation engines
[apiInstance validateUsingGET2With:id
    excludedAssertions:excludedAssertions
    excludedFilingRules:excludedFilingRules
    validateDimensions:validateDimensions
    validateFilingRules:validateFilingRules
    validateFormulas:validateFormulas
    validateXBRL:validateXBRL
              completionHandler: ^(RapValidationDataDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RestApiForRaportadoServices = require('rest_api_for_raportado_services');

var api = new RestApiForRaportadoServices.XbrlRestControllerApi()

var id = 789; // {Long} Report ID

var opts = { 
  'excludedAssertions': excludedAssertions_example, // {String} List of Formula assertion IDs to be excluded
  'excludedFilingRules': excludedFilingRules_example, // {String} List of filing rules IDs to be excluded
  'validateDimensions': true, // {Boolean} Switch ON/OFF dimensions validation
  'validateFilingRules': true, // {Boolean} Switch ON/OFF filing rules validation
  'validateFormulas': true, // {Boolean} Switch ON/OFF formula validation
  'validateXBRL': true // {Boolean} Switch ON/OFF XBRL 2.1 validation
};

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

namespace Example
{
    public class validateUsingGET2Example
    {
        public void main()
        {
            
            var apiInstance = new XbrlRestControllerApi();
            var id = 789;  // Long | Report ID
            var excludedAssertions = excludedAssertions_example;  // String | List of Formula assertion IDs to be excluded (optional) 
            var excludedFilingRules = excludedFilingRules_example;  // String | List of filing rules IDs to be excluded (optional) 
            var validateDimensions = true;  // Boolean | Switch ON/OFF dimensions validation (optional) 
            var validateFilingRules = true;  // Boolean | Switch ON/OFF filing rules validation (optional) 
            var validateFormulas = true;  // Boolean | Switch ON/OFF formula validation (optional) 
            var validateXBRL = true;  // Boolean | Switch ON/OFF XBRL 2.1 validation (optional) 

            try
            {
                // Validate XBRL report against selected validation engines
                RapValidationDataDTO result = apiInstance.validateUsingGET2(id, excludedAssertions, excludedFilingRules, validateDimensions, validateFilingRules, validateFormulas, validateXBRL);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling XbrlRestControllerApi.validateUsingGET2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\XbrlRestControllerApi();
$id = 789; // Long | Report ID
$excludedAssertions = excludedAssertions_example; // String | List of Formula assertion IDs to be excluded
$excludedFilingRules = excludedFilingRules_example; // String | List of filing rules IDs to be excluded
$validateDimensions = true; // Boolean | Switch ON/OFF dimensions validation
$validateFilingRules = true; // Boolean | Switch ON/OFF filing rules validation
$validateFormulas = true; // Boolean | Switch ON/OFF formula validation
$validateXBRL = true; // Boolean | Switch ON/OFF XBRL 2.1 validation

try {
    $result = $api_instance->validateUsingGET2($id, $excludedAssertions, $excludedFilingRules, $validateDimensions, $validateFilingRules, $validateFormulas, $validateXBRL);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling XbrlRestControllerApi->validateUsingGET2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::XbrlRestControllerApi;

my $api_instance = WWW::SwaggerClient::XbrlRestControllerApi->new();
my $id = 789; # Long | Report ID
my $excludedAssertions = excludedAssertions_example; # String | List of Formula assertion IDs to be excluded
my $excludedFilingRules = excludedFilingRules_example; # String | List of filing rules IDs to be excluded
my $validateDimensions = true; # Boolean | Switch ON/OFF dimensions validation
my $validateFilingRules = true; # Boolean | Switch ON/OFF filing rules validation
my $validateFormulas = true; # Boolean | Switch ON/OFF formula validation
my $validateXBRL = true; # Boolean | Switch ON/OFF XBRL 2.1 validation

eval { 
    my $result = $api_instance->validateUsingGET2(id => $id, excludedAssertions => $excludedAssertions, excludedFilingRules => $excludedFilingRules, validateDimensions => $validateDimensions, validateFilingRules => $validateFilingRules, validateFormulas => $validateFormulas, validateXBRL => $validateXBRL);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling XbrlRestControllerApi->validateUsingGET2: $@\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.XbrlRestControllerApi()
id = 789 # Long | Report ID
excludedAssertions = excludedAssertions_example # String | List of Formula assertion IDs to be excluded (optional)
excludedFilingRules = excludedFilingRules_example # String | List of filing rules IDs to be excluded (optional)
validateDimensions = true # Boolean | Switch ON/OFF dimensions validation (optional)
validateFilingRules = true # Boolean | Switch ON/OFF filing rules validation (optional)
validateFormulas = true # Boolean | Switch ON/OFF formula validation (optional)
validateXBRL = true # Boolean | Switch ON/OFF XBRL 2.1 validation (optional)

try: 
    # Validate XBRL report against selected validation engines
    api_response = api_instance.validate_using_get2(id, excludedAssertions=excludedAssertions, excludedFilingRules=excludedFilingRules, validateDimensions=validateDimensions, validateFilingRules=validateFilingRules, validateFormulas=validateFormulas, validateXBRL=validateXBRL)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling XbrlRestControllerApi->validateUsingGET2: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Report ID
Required
Query parameters
Name Description
excludedAssertions
String
List of Formula assertion IDs to be excluded
excludedFilingRules
String
List of filing rules IDs to be excluded
validateDimensions
Boolean
Switch ON/OFF dimensions validation
validateFilingRules
Boolean
Switch ON/OFF filing rules validation
validateFormulas
Boolean
Switch ON/OFF formula validation
validateXBRL
Boolean
Switch ON/OFF XBRL 2.1 validation

Responses

Status: 200 - OK

Status: 400 - Validation Exception

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Resource Does Not Exist

Status: 422 - Invalid File Format