ScoreQL REST API

Corpus

corpusGet

XML Score

Stored Score, an XML document for the original score (s)


/corpus

Usage and SDK Samples

curl -X get "http://cchum-kvm-scorelibneuma.in2p3.fr/ScoreQL/rest/corpus?id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CorpusApi;

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

public class CorpusApiExample {

    public static void main(String[] args) {
        
        CorpusApi apiInstance = new CorpusApi();
        String id = id_example; // String | Score identifier (corpus/xml_file)
        try {
            apiInstance.corpusGet(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling CorpusApi#corpusGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CorpusApi;

public class CorpusApiExample {

    public static void main(String[] args) {
        CorpusApi apiInstance = new CorpusApi();
        String id = id_example; // String | Score identifier (corpus/xml_file)
        try {
            apiInstance.corpusGet(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling CorpusApi#corpusGet");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Score identifier (corpus/xml_file) (optional) (default to methodes/adampiano/147_001.xml)

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

// XML Score
[apiInstance corpusGetWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScoreQlRestApi = require('score_ql_rest_api');

var api = new ScoreQlRestApi.CorpusApi()

var opts = { 
  'id': id_example // {String} Score identifier (corpus/xml_file)
};

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

namespace Example
{
    public class corpusGetExample
    {
        public void main()
        {
            
            var apiInstance = new CorpusApi();
            var id = id_example;  // String | Score identifier (corpus/xml_file) (optional)  (default to methodes/adampiano/147_001.xml)

            try
            {
                // XML Score
                apiInstance.corpusGet(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CorpusApi.corpusGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CorpusApi();
$id = id_example; // String | Score identifier (corpus/xml_file)

try {
    $api_instance->corpusGet($id);
} catch (Exception $e) {
    echo 'Exception when calling CorpusApi->corpusGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Query parameters
Name Description
id

Responses

Status: 200 - XML source file

Status: 0 - Unexpected error


updateCorpusGet

Corpus update

Update corpus by scanning a local folder (data/Neuma). Each sub-folder is a corpus, and each XML file is stored in ScoreQL.


/update/corpus

Usage and SDK Samples

curl -X get "http://cchum-kvm-scorelibneuma.in2p3.fr/ScoreQL/rest/update/corpus"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CorpusApi;

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

public class CorpusApiExample {

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

public class CorpusApiExample {

    public static void main(String[] args) {
        CorpusApi apiInstance = new CorpusApi();
        try {
            apiInstance.updateCorpusGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling CorpusApi#updateCorpusGet");
            e.printStackTrace();
        }
    }
}

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

// Corpus update
[apiInstance updateCorpusGetWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScoreQlRestApi = require('score_ql_rest_api');

var api = new ScoreQlRestApi.CorpusApi()

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

namespace Example
{
    public class updateCorpusGetExample
    {
        public void main()
        {
            
            var apiInstance = new CorpusApi();

            try
            {
                // Corpus update
                apiInstance.updateCorpusGet();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CorpusApi.updateCorpusGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

try {
    $api_instance->updateCorpusGet();
} catch (Exception $e) {
    echo 'Exception when calling CorpusApi->updateCorpusGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Responses

Status: 200 - Report of insertions in the corpora

Status: 0 - Unexpected error


updateCorpusPost

Adds/Update an XML Score to a given corpus

__NOT YET IMPLEMENTED!__ Gives the XML document for a given score and put it in the corresponding corpus.


/update/corpus

Usage and SDK Samples

curl -X post "http://cchum-kvm-scorelibneuma.in2p3.fr/ScoreQL/rest/update/corpus?score=&corpus="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CorpusApi;

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

public class CorpusApiExample {

    public static void main(String[] args) {
        
        CorpusApi apiInstance = new CorpusApi();
        String score = score_example; // String | XML document to update
        String corpus = corpus_example; // String | The corpus and file_id in which to store the score
        try {
            apiInstance.updateCorpusPost(score, corpus);
        } catch (ApiException e) {
            System.err.println("Exception when calling CorpusApi#updateCorpusPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CorpusApi;

public class CorpusApiExample {

    public static void main(String[] args) {
        CorpusApi apiInstance = new CorpusApi();
        String score = score_example; // String | XML document to update
        String corpus = corpus_example; // String | The corpus and file_id in which to store the score
        try {
            apiInstance.updateCorpusPost(score, corpus);
        } catch (ApiException e) {
            System.err.println("Exception when calling CorpusApi#updateCorpusPost");
            e.printStackTrace();
        }
    }
}
String *score = score_example; // XML document to update
String *corpus = corpus_example; // The corpus and file_id in which to store the score (default to methodes/adampiano/147_001.xml)

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

// Adds/Update an XML Score to a given corpus
[apiInstance updateCorpusPostWith:score
    corpus:corpus
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScoreQlRestApi = require('score_ql_rest_api');

var api = new ScoreQlRestApi.CorpusApi()

var score = score_example; // {String} XML document to update

var corpus = corpus_example; // {String} The corpus and file_id in which to store the score


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

namespace Example
{
    public class updateCorpusPostExample
    {
        public void main()
        {
            
            var apiInstance = new CorpusApi();
            var score = score_example;  // String | XML document to update
            var corpus = corpus_example;  // String | The corpus and file_id in which to store the score (default to methodes/adampiano/147_001.xml)

            try
            {
                // Adds/Update an XML Score to a given corpus
                apiInstance.updateCorpusPost(score, corpus);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CorpusApi.updateCorpusPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CorpusApi();
$score = score_example; // String | XML document to update
$corpus = corpus_example; // String | The corpus and file_id in which to store the score

try {
    $api_instance->updateCorpusPost($score, $corpus);
} catch (Exception $e) {
    echo 'Exception when calling CorpusApi->updateCorpusPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Query parameters
Name Description
score*
corpus*

Responses

Status: 200 - Report of insertions in the corpora

Status: 0 - Unexpected error


updateMviewGet

Mapping update

Proceeds the mapping of all documents (/corpus) in the corpora with the corresponding mapping documents (/mapping).


/update/mview

Usage and SDK Samples

curl -X get "http://cchum-kvm-scorelibneuma.in2p3.fr/ScoreQL/rest/update/mview?corpus="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CorpusApi;

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

public class CorpusApiExample {

    public static void main(String[] args) {
        
        CorpusApi apiInstance = new CorpusApi();
        String corpus = corpus_example; // String | __NOT YET IMPLEMENTED!__ Targets a specific corpus with linked mapping document
        try {
            apiInstance.updateMviewGet(corpus);
        } catch (ApiException e) {
            System.err.println("Exception when calling CorpusApi#updateMviewGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CorpusApi;

public class CorpusApiExample {

    public static void main(String[] args) {
        CorpusApi apiInstance = new CorpusApi();
        String corpus = corpus_example; // String | __NOT YET IMPLEMENTED!__ Targets a specific corpus with linked mapping document
        try {
            apiInstance.updateMviewGet(corpus);
        } catch (ApiException e) {
            System.err.println("Exception when calling CorpusApi#updateMviewGet");
            e.printStackTrace();
        }
    }
}
String *corpus = corpus_example; // __NOT YET IMPLEMENTED!__ Targets a specific corpus with linked mapping document (optional) (default to methodes/adampiano)

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

// Mapping update
[apiInstance updateMviewGetWith:corpus
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScoreQlRestApi = require('score_ql_rest_api');

var api = new ScoreQlRestApi.CorpusApi()

var opts = { 
  'corpus': corpus_example // {String} __NOT YET IMPLEMENTED!__ Targets a specific corpus with linked mapping document
};

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

namespace Example
{
    public class updateMviewGetExample
    {
        public void main()
        {
            
            var apiInstance = new CorpusApi();
            var corpus = corpus_example;  // String | __NOT YET IMPLEMENTED!__ Targets a specific corpus with linked mapping document (optional)  (default to methodes/adampiano)

            try
            {
                // Mapping update
                apiInstance.updateMviewGet(corpus);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CorpusApi.updateMviewGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CorpusApi();
$corpus = corpus_example; // String | __NOT YET IMPLEMENTED!__ Targets a specific corpus with linked mapping document

try {
    $api_instance->updateMviewGet($corpus);
} catch (Exception $e) {
    echo 'Exception when calling CorpusApi->updateMviewGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Query parameters
Name Description
corpus

Responses

Status: 200 - Reports the mapping process. Gives the number of mapped documents for each corpus

Status: 0 - Unexpected error


Log

queryLogGet

Execution log of previous queries

It returns an XML documents that integrates the different steps of the query execution in BaseX, ScoreQL and music21


/query/log

Usage and SDK Samples

curl -X get "http://cchum-kvm-scorelibneuma.in2p3.fr/ScoreQL/rest/query/log"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LogApi;

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

public class LogApiExample {

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

public class LogApiExample {

    public static void main(String[] args) {
        LogApi apiInstance = new LogApi();
        try {
            apiInstance.queryLogGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling LogApi#queryLogGet");
            e.printStackTrace();
        }
    }
}

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

// Execution log of previous queries
[apiInstance queryLogGetWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScoreQlRestApi = require('score_ql_rest_api');

var api = new ScoreQlRestApi.LogApi()

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

namespace Example
{
    public class queryLogGetExample
    {
        public void main()
        {
            
            var apiInstance = new LogApi();

            try
            {
                // Execution log of previous queries
                apiInstance.queryLogGet();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LogApi.queryLogGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

try {
    $api_instance->queryLogGet();
} catch (Exception $e) {
    echo 'Exception when calling LogApi->queryLogGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Responses

Status: 200 - List of logged instructions

Status: 0 - Unexpected error


Mapping

mappingGet

List of mapping documents for each corpus

For each corpus is linked a mapping XML document which gives XPaths to extract values for the materialized document


/mapping

Usage and SDK Samples

curl -X get "http://cchum-kvm-scorelibneuma.in2p3.fr/ScoreQL/rest/mapping?corpus="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MappingApi;

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

public class MappingApiExample {

    public static void main(String[] args) {
        
        MappingApi apiInstance = new MappingApi();
        String corpus = corpus_example; // String | Corpus/Score identifier to filter out mapping documents
        try {
            apiInstance.mappingGet(corpus);
        } catch (ApiException e) {
            System.err.println("Exception when calling MappingApi#mappingGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MappingApi;

public class MappingApiExample {

    public static void main(String[] args) {
        MappingApi apiInstance = new MappingApi();
        String corpus = corpus_example; // String | Corpus/Score identifier to filter out mapping documents
        try {
            apiInstance.mappingGet(corpus);
        } catch (ApiException e) {
            System.err.println("Exception when calling MappingApi#mappingGet");
            e.printStackTrace();
        }
    }
}
String *corpus = corpus_example; // Corpus/Score identifier to filter out mapping documents (optional) (default to methodes/adampiano)

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

// List of mapping documents for each corpus
[apiInstance mappingGetWith:corpus
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScoreQlRestApi = require('score_ql_rest_api');

var api = new ScoreQlRestApi.MappingApi()

var opts = { 
  'corpus': corpus_example // {String} Corpus/Score identifier to filter out mapping documents
};

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

namespace Example
{
    public class mappingGetExample
    {
        public void main()
        {
            
            var apiInstance = new MappingApi();
            var corpus = corpus_example;  // String | Corpus/Score identifier to filter out mapping documents (optional)  (default to methodes/adampiano)

            try
            {
                // List of mapping documents for each corpus
                apiInstance.mappingGet(corpus);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MappingApi.mappingGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\MappingApi();
$corpus = corpus_example; // String | Corpus/Score identifier to filter out mapping documents

try {
    $api_instance->mappingGet($corpus);
} catch (Exception $e) {
    echo 'Exception when calling MappingApi->mappingGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Query parameters
Name Description
corpus

Responses

Status: 200 - List all XML files used for mapping

Status: 0 - Unexpected error


mappingMviewGet

List of materialized documents in the corpora

For each Score is linked a materialized document which is produced by the processing on the Score by the corresponding mapping document


/mapping/mview

Usage and SDK Samples

curl -X get "http://cchum-kvm-scorelibneuma.in2p3.fr/ScoreQL/rest/mapping/mview?id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MappingApi;

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

public class MappingApiExample {

    public static void main(String[] args) {
        
        MappingApi apiInstance = new MappingApi();
        String id = id_example; // String | Score identifier to filter out mapped documents
        try {
            apiInstance.mappingMviewGet(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling MappingApi#mappingMviewGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MappingApi;

public class MappingApiExample {

    public static void main(String[] args) {
        MappingApi apiInstance = new MappingApi();
        String id = id_example; // String | Score identifier to filter out mapped documents
        try {
            apiInstance.mappingMviewGet(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling MappingApi#mappingMviewGet");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Score identifier to filter out mapped documents (optional) (default to Neuma/methodes/adampiano)

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

// List of materialized documents in the corpora
[apiInstance mappingMviewGetWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScoreQlRestApi = require('score_ql_rest_api');

var api = new ScoreQlRestApi.MappingApi()

var opts = { 
  'id': id_example // {String} Score identifier to filter out mapped documents
};

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

namespace Example
{
    public class mappingMviewGetExample
    {
        public void main()
        {
            
            var apiInstance = new MappingApi();
            var id = id_example;  // String | Score identifier to filter out mapped documents (optional)  (default to Neuma/methodes/adampiano)

            try
            {
                // List of materialized documents in the corpora
                apiInstance.mappingMviewGet(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MappingApi.mappingMviewGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\MappingApi();
$id = id_example; // String | Score identifier to filter out mapped documents

try {
    $api_instance->mappingMviewGet($id);
} catch (Exception $e) {
    echo 'Exception when calling MappingApi->mappingMviewGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Query parameters
Name Description
id

Responses

Status: 200 - List of XML mapped documents

Status: 0 - Unexpected error


mappingPost

Adds/Update a mapping document

__NOT YET IMPLEMENTED!__ The mapping document is stored/updated into the repository. This document gives the schema of generated documents and XPath to information that will be taken from the Score.


/mapping

Usage and SDK Samples

curl -X post "http://cchum-kvm-scorelibneuma.in2p3.fr/ScoreQL/rest/mapping?mapping=&corpus="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MappingApi;

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

public class MappingApiExample {

    public static void main(String[] args) {
        
        MappingApi apiInstance = new MappingApi();
        String mapping = mapping_example; // String | XML document to store
        String corpus = corpus_example; // String | The corpus to which the mapping document will be linked to.
        try {
            apiInstance.mappingPost(mapping, corpus);
        } catch (ApiException e) {
            System.err.println("Exception when calling MappingApi#mappingPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MappingApi;

public class MappingApiExample {

    public static void main(String[] args) {
        MappingApi apiInstance = new MappingApi();
        String mapping = mapping_example; // String | XML document to store
        String corpus = corpus_example; // String | The corpus to which the mapping document will be linked to.
        try {
            apiInstance.mappingPost(mapping, corpus);
        } catch (ApiException e) {
            System.err.println("Exception when calling MappingApi#mappingPost");
            e.printStackTrace();
        }
    }
}
String *mapping = mapping_example; // XML document to store
String *corpus = corpus_example; // The corpus to which the mapping document will be linked to. (default to methodes/adampiano)

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

// Adds/Update a mapping document
[apiInstance mappingPostWith:mapping
    corpus:corpus
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScoreQlRestApi = require('score_ql_rest_api');

var api = new ScoreQlRestApi.MappingApi()

var mapping = mapping_example; // {String} XML document to store

var corpus = corpus_example; // {String} The corpus to which the mapping document will be linked to.


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

namespace Example
{
    public class mappingPostExample
    {
        public void main()
        {
            
            var apiInstance = new MappingApi();
            var mapping = mapping_example;  // String | XML document to store
            var corpus = corpus_example;  // String | The corpus to which the mapping document will be linked to. (default to methodes/adampiano)

            try
            {
                // Adds/Update a mapping document
                apiInstance.mappingPost(mapping, corpus);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MappingApi.mappingPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\MappingApi();
$mapping = mapping_example; // String | XML document to store
$corpus = corpus_example; // String | The corpus to which the mapping document will be linked to.

try {
    $api_instance->mappingPost($mapping, $corpus);
} catch (Exception $e) {
    echo 'Exception when calling MappingApi->mappingPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Query parameters
Name Description
mapping*
corpus*

Responses

Status: 200 - Report of insertions in the corpora

Status: 0 - Unexpected error


updateMviewGet

Mapping update

Proceeds the mapping of all documents (/corpus) in the corpora with the corresponding mapping documents (/mapping).


/update/mview

Usage and SDK Samples

curl -X get "http://cchum-kvm-scorelibneuma.in2p3.fr/ScoreQL/rest/update/mview?corpus="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MappingApi;

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

public class MappingApiExample {

    public static void main(String[] args) {
        
        MappingApi apiInstance = new MappingApi();
        String corpus = corpus_example; // String | __NOT YET IMPLEMENTED!__ Targets a specific corpus with linked mapping document
        try {
            apiInstance.updateMviewGet(corpus);
        } catch (ApiException e) {
            System.err.println("Exception when calling MappingApi#updateMviewGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MappingApi;

public class MappingApiExample {

    public static void main(String[] args) {
        MappingApi apiInstance = new MappingApi();
        String corpus = corpus_example; // String | __NOT YET IMPLEMENTED!__ Targets a specific corpus with linked mapping document
        try {
            apiInstance.updateMviewGet(corpus);
        } catch (ApiException e) {
            System.err.println("Exception when calling MappingApi#updateMviewGet");
            e.printStackTrace();
        }
    }
}
String *corpus = corpus_example; // __NOT YET IMPLEMENTED!__ Targets a specific corpus with linked mapping document (optional) (default to methodes/adampiano)

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

// Mapping update
[apiInstance updateMviewGetWith:corpus
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScoreQlRestApi = require('score_ql_rest_api');

var api = new ScoreQlRestApi.MappingApi()

var opts = { 
  'corpus': corpus_example // {String} __NOT YET IMPLEMENTED!__ Targets a specific corpus with linked mapping document
};

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

namespace Example
{
    public class updateMviewGetExample
    {
        public void main()
        {
            
            var apiInstance = new MappingApi();
            var corpus = corpus_example;  // String | __NOT YET IMPLEMENTED!__ Targets a specific corpus with linked mapping document (optional)  (default to methodes/adampiano)

            try
            {
                // Mapping update
                apiInstance.updateMviewGet(corpus);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MappingApi.updateMviewGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\MappingApi();
$corpus = corpus_example; // String | __NOT YET IMPLEMENTED!__ Targets a specific corpus with linked mapping document

try {
    $api_instance->updateMviewGet($corpus);
} catch (Exception $e) {
    echo 'Exception when calling MappingApi->updateMviewGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Query parameters
Name Description
corpus

Responses

Status: 200 - Reports the mapping process. Gives the number of mapped documents for each corpus

Status: 0 - Unexpected error


Query

queryFunctionsGet

List of functions/operators

This interface returns the list of usable functions and operators in ScoreQL (XQuery queries). It provides the imputs and outputs used by BaseX in order to query underlying scores.


/query/functions

Usage and SDK Samples

curl -X get "http://cchum-kvm-scorelibneuma.in2p3.fr/ScoreQL/rest/query/functions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QueryApi;

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

public class QueryApiExample {

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

public class QueryApiExample {

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

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

// List of functions/operators
[apiInstance queryFunctionsGetWithCompletionHandler: 
              ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScoreQlRestApi = require('score_ql_rest_api');

var api = new ScoreQlRestApi.QueryApi()

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

namespace Example
{
    public class queryFunctionsGetExample
    {
        public void main()
        {
            
            var apiInstance = new QueryApi();

            try
            {
                // List of functions/operators
                'String' result = apiInstance.queryFunctionsGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueryApi.queryFunctionsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

try {
    $result = $api_instance->queryFunctionsGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryApi->queryFunctionsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Responses

Status: 200 - List functions callable in ScoreQL

Status: 0 - Unexpected error


queryLogGet

Execution log of previous queries

It returns an XML documents that integrates the different steps of the query execution in BaseX, ScoreQL and music21


/query/log

Usage and SDK Samples

curl -X get "http://cchum-kvm-scorelibneuma.in2p3.fr/ScoreQL/rest/query/log"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QueryApi;

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

public class QueryApiExample {

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

public class QueryApiExample {

    public static void main(String[] args) {
        QueryApi apiInstance = new QueryApi();
        try {
            apiInstance.queryLogGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryApi#queryLogGet");
            e.printStackTrace();
        }
    }
}

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

// Execution log of previous queries
[apiInstance queryLogGetWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScoreQlRestApi = require('score_ql_rest_api');

var api = new ScoreQlRestApi.QueryApi()

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

namespace Example
{
    public class queryLogGetExample
    {
        public void main()
        {
            
            var apiInstance = new QueryApi();

            try
            {
                // Execution log of previous queries
                apiInstance.queryLogGet();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueryApi.queryLogGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

try {
    $api_instance->queryLogGet();
} catch (Exception $e) {
    echo 'Exception when calling QueryApi->queryLogGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Responses

Status: 200 - List of logged instructions

Status: 0 - Unexpected error


queryPost

Query the virtual corpus in order to produce new scores

An XQuery query must be provided in POST in order to query the database "ScoreMView". Every queries must be written along with: * `import module namespace s = "fr.cnam.vertigo.scorelib.ScoreQL";` * `for $i in fn:collection("ScoreMView")`


/query

Usage and SDK Samples

curl -X post "http://cchum-kvm-scorelibneuma.in2p3.fr/ScoreQL/rest/query?query="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QueryApi;

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

public class QueryApiExample {

    public static void main(String[] args) {
        
        QueryApi apiInstance = new QueryApi();
        String query = query_example; // String | XQuery query on corpus "`ScoreMView`"
        try {
            'String' result = apiInstance.queryPost(query);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryApi#queryPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QueryApi;

public class QueryApiExample {

    public static void main(String[] args) {
        QueryApi apiInstance = new QueryApi();
        String query = query_example; // String | XQuery query on corpus "`ScoreMView`"
        try {
            'String' result = apiInstance.queryPost(query);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryApi#queryPost");
            e.printStackTrace();
        }
    }
}
String *query = query_example; // XQuery query on corpus "`ScoreMView`" (default to import module namespace s = \"fr.cnam.vertigo.scorelib.ScoreQL\"; for $i in  fn:collection(\"ScoreMView\") where contains($i//title, \"variations\") let $j := s:Score($i//piano1) return $j)

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

// Query the virtual corpus in order to produce new scores
[apiInstance queryPostWith:query
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScoreQlRestApi = require('score_ql_rest_api');

var api = new ScoreQlRestApi.QueryApi()

var query = query_example; // {String} XQuery query on corpus "`ScoreMView`"


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

namespace Example
{
    public class queryPostExample
    {
        public void main()
        {
            
            var apiInstance = new QueryApi();
            var query = query_example;  // String | XQuery query on corpus "`ScoreMView`" (default to import module namespace s = \"fr.cnam.vertigo.scorelib.ScoreQL\"; for $i in  fn:collection(\"ScoreMView\") where contains($i//title, \"variations\") let $j := s:Score($i//piano1) return $j)

            try
            {
                // Query the virtual corpus in order to produce new scores
                'String' result = apiInstance.queryPost(query);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueryApi.queryPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\QueryApi();
$query = query_example; // String | XQuery query on corpus "`ScoreMView`"

try {
    $result = $api_instance->queryPost($query);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueryApi->queryPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Query parameters
Name Description
query*

Responses

Status: 200 - List all scores

Status: 0 - The error log from the exception process


Update

mappingPost

Adds/Update a mapping document

__NOT YET IMPLEMENTED!__ The mapping document is stored/updated into the repository. This document gives the schema of generated documents and XPath to information that will be taken from the Score.


/mapping

Usage and SDK Samples

curl -X post "http://cchum-kvm-scorelibneuma.in2p3.fr/ScoreQL/rest/mapping?mapping=&corpus="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UpdateApi;

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

public class UpdateApiExample {

    public static void main(String[] args) {
        
        UpdateApi apiInstance = new UpdateApi();
        String mapping = mapping_example; // String | XML document to store
        String corpus = corpus_example; // String | The corpus to which the mapping document will be linked to.
        try {
            apiInstance.mappingPost(mapping, corpus);
        } catch (ApiException e) {
            System.err.println("Exception when calling UpdateApi#mappingPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UpdateApi;

public class UpdateApiExample {

    public static void main(String[] args) {
        UpdateApi apiInstance = new UpdateApi();
        String mapping = mapping_example; // String | XML document to store
        String corpus = corpus_example; // String | The corpus to which the mapping document will be linked to.
        try {
            apiInstance.mappingPost(mapping, corpus);
        } catch (ApiException e) {
            System.err.println("Exception when calling UpdateApi#mappingPost");
            e.printStackTrace();
        }
    }
}
String *mapping = mapping_example; // XML document to store
String *corpus = corpus_example; // The corpus to which the mapping document will be linked to. (default to methodes/adampiano)

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

// Adds/Update a mapping document
[apiInstance mappingPostWith:mapping
    corpus:corpus
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScoreQlRestApi = require('score_ql_rest_api');

var api = new ScoreQlRestApi.UpdateApi()

var mapping = mapping_example; // {String} XML document to store

var corpus = corpus_example; // {String} The corpus to which the mapping document will be linked to.


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

namespace Example
{
    public class mappingPostExample
    {
        public void main()
        {
            
            var apiInstance = new UpdateApi();
            var mapping = mapping_example;  // String | XML document to store
            var corpus = corpus_example;  // String | The corpus to which the mapping document will be linked to. (default to methodes/adampiano)

            try
            {
                // Adds/Update a mapping document
                apiInstance.mappingPost(mapping, corpus);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UpdateApi.mappingPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UpdateApi();
$mapping = mapping_example; // String | XML document to store
$corpus = corpus_example; // String | The corpus to which the mapping document will be linked to.

try {
    $api_instance->mappingPost($mapping, $corpus);
} catch (Exception $e) {
    echo 'Exception when calling UpdateApi->mappingPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Query parameters
Name Description
mapping*
corpus*

Responses

Status: 200 - Report of insertions in the corpora

Status: 0 - Unexpected error


updateCorpusGet

Corpus update

Update corpus by scanning a local folder (data/Neuma). Each sub-folder is a corpus, and each XML file is stored in ScoreQL.


/update/corpus

Usage and SDK Samples

curl -X get "http://cchum-kvm-scorelibneuma.in2p3.fr/ScoreQL/rest/update/corpus"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UpdateApi;

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

public class UpdateApiExample {

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

public class UpdateApiExample {

    public static void main(String[] args) {
        UpdateApi apiInstance = new UpdateApi();
        try {
            apiInstance.updateCorpusGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling UpdateApi#updateCorpusGet");
            e.printStackTrace();
        }
    }
}

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

// Corpus update
[apiInstance updateCorpusGetWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScoreQlRestApi = require('score_ql_rest_api');

var api = new ScoreQlRestApi.UpdateApi()

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

namespace Example
{
    public class updateCorpusGetExample
    {
        public void main()
        {
            
            var apiInstance = new UpdateApi();

            try
            {
                // Corpus update
                apiInstance.updateCorpusGet();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UpdateApi.updateCorpusGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

try {
    $api_instance->updateCorpusGet();
} catch (Exception $e) {
    echo 'Exception when calling UpdateApi->updateCorpusGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Responses

Status: 200 - Report of insertions in the corpora

Status: 0 - Unexpected error


updateCorpusPost

Adds/Update an XML Score to a given corpus

__NOT YET IMPLEMENTED!__ Gives the XML document for a given score and put it in the corresponding corpus.


/update/corpus

Usage and SDK Samples

curl -X post "http://cchum-kvm-scorelibneuma.in2p3.fr/ScoreQL/rest/update/corpus?score=&corpus="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UpdateApi;

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

public class UpdateApiExample {

    public static void main(String[] args) {
        
        UpdateApi apiInstance = new UpdateApi();
        String score = score_example; // String | XML document to update
        String corpus = corpus_example; // String | The corpus and file_id in which to store the score
        try {
            apiInstance.updateCorpusPost(score, corpus);
        } catch (ApiException e) {
            System.err.println("Exception when calling UpdateApi#updateCorpusPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UpdateApi;

public class UpdateApiExample {

    public static void main(String[] args) {
        UpdateApi apiInstance = new UpdateApi();
        String score = score_example; // String | XML document to update
        String corpus = corpus_example; // String | The corpus and file_id in which to store the score
        try {
            apiInstance.updateCorpusPost(score, corpus);
        } catch (ApiException e) {
            System.err.println("Exception when calling UpdateApi#updateCorpusPost");
            e.printStackTrace();
        }
    }
}
String *score = score_example; // XML document to update
String *corpus = corpus_example; // The corpus and file_id in which to store the score (default to methodes/adampiano/147_001.xml)

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

// Adds/Update an XML Score to a given corpus
[apiInstance updateCorpusPostWith:score
    corpus:corpus
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScoreQlRestApi = require('score_ql_rest_api');

var api = new ScoreQlRestApi.UpdateApi()

var score = score_example; // {String} XML document to update

var corpus = corpus_example; // {String} The corpus and file_id in which to store the score


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

namespace Example
{
    public class updateCorpusPostExample
    {
        public void main()
        {
            
            var apiInstance = new UpdateApi();
            var score = score_example;  // String | XML document to update
            var corpus = corpus_example;  // String | The corpus and file_id in which to store the score (default to methodes/adampiano/147_001.xml)

            try
            {
                // Adds/Update an XML Score to a given corpus
                apiInstance.updateCorpusPost(score, corpus);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UpdateApi.updateCorpusPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UpdateApi();
$score = score_example; // String | XML document to update
$corpus = corpus_example; // String | The corpus and file_id in which to store the score

try {
    $api_instance->updateCorpusPost($score, $corpus);
} catch (Exception $e) {
    echo 'Exception when calling UpdateApi->updateCorpusPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Query parameters
Name Description
score*
corpus*

Responses

Status: 200 - Report of insertions in the corpora

Status: 0 - Unexpected error


updateMviewGet

Mapping update

Proceeds the mapping of all documents (/corpus) in the corpora with the corresponding mapping documents (/mapping).


/update/mview

Usage and SDK Samples

curl -X get "http://cchum-kvm-scorelibneuma.in2p3.fr/ScoreQL/rest/update/mview?corpus="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UpdateApi;

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

public class UpdateApiExample {

    public static void main(String[] args) {
        
        UpdateApi apiInstance = new UpdateApi();
        String corpus = corpus_example; // String | __NOT YET IMPLEMENTED!__ Targets a specific corpus with linked mapping document
        try {
            apiInstance.updateMviewGet(corpus);
        } catch (ApiException e) {
            System.err.println("Exception when calling UpdateApi#updateMviewGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UpdateApi;

public class UpdateApiExample {

    public static void main(String[] args) {
        UpdateApi apiInstance = new UpdateApi();
        String corpus = corpus_example; // String | __NOT YET IMPLEMENTED!__ Targets a specific corpus with linked mapping document
        try {
            apiInstance.updateMviewGet(corpus);
        } catch (ApiException e) {
            System.err.println("Exception when calling UpdateApi#updateMviewGet");
            e.printStackTrace();
        }
    }
}
String *corpus = corpus_example; // __NOT YET IMPLEMENTED!__ Targets a specific corpus with linked mapping document (optional) (default to methodes/adampiano)

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

// Mapping update
[apiInstance updateMviewGetWith:corpus
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScoreQlRestApi = require('score_ql_rest_api');

var api = new ScoreQlRestApi.UpdateApi()

var opts = { 
  'corpus': corpus_example // {String} __NOT YET IMPLEMENTED!__ Targets a specific corpus with linked mapping document
};

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

namespace Example
{
    public class updateMviewGetExample
    {
        public void main()
        {
            
            var apiInstance = new UpdateApi();
            var corpus = corpus_example;  // String | __NOT YET IMPLEMENTED!__ Targets a specific corpus with linked mapping document (optional)  (default to methodes/adampiano)

            try
            {
                // Mapping update
                apiInstance.updateMviewGet(corpus);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UpdateApi.updateMviewGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UpdateApi();
$corpus = corpus_example; // String | __NOT YET IMPLEMENTED!__ Targets a specific corpus with linked mapping document

try {
    $api_instance->updateMviewGet($corpus);
} catch (Exception $e) {
    echo 'Exception when calling UpdateApi->updateMviewGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Query parameters
Name Description
corpus

Responses

Status: 200 - Reports the mapping process. Gives the number of mapped documents for each corpus

Status: 0 - Unexpected error


Generated 2017-02-15T21:29:56.835Z