AsfmRestfulApiForPkm

Asfm

asfmToDoc

Converts an Abstract Semi-Formal Model (ASFM) to a Microsoft Word .docx file


/asfm/asfm_to_doc/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_asfm_1:8086/asfm/asfm_to_doc/{dbName}?asynchronous=true&invocationID=invocationID_example" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AsfmApi;

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

public class AsfmApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        AsfmApi apiInstance = new AsfmApi();
        String dbName = dbName_example; // String | The project name where to find the Abstract Semi-Formal Model (ASFM) and put the .docx file
        String key = key_example; // String | Access key to the PKM
        InlineObject1 body = ; // InlineObject1 | 
        Boolean asynchronous = true; // Boolean | flag to control asynchronous/synchronous execution of asfm_to_doc job. When invocationID is specified, this flag is implicitely set to false (synchronous execution).
        String invocationID = invocationID_example; // String | invocation identifier (optional)

        try {
            Job result = apiInstance.asfmToDoc(dbName, key, body, asynchronous, invocationID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AsfmApi#asfmToDoc");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AsfmApi;

public class AsfmApiExample {
    public static void main(String[] args) {
        AsfmApi apiInstance = new AsfmApi();
        String dbName = dbName_example; // String | The project name where to find the Abstract Semi-Formal Model (ASFM) and put the .docx file
        String key = key_example; // String | Access key to the PKM
        InlineObject1 body = ; // InlineObject1 | 
        Boolean asynchronous = true; // Boolean | flag to control asynchronous/synchronous execution of asfm_to_doc job. When invocationID is specified, this flag is implicitely set to false (synchronous execution).
        String invocationID = invocationID_example; // String | invocation identifier (optional)

        try {
            Job result = apiInstance.asfmToDoc(dbName, key, body, asynchronous, invocationID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AsfmApi#asfmToDoc");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AsfmApi *apiInstance = [[AsfmApi alloc] init];
String *dbName = dbName_example; // The project name where to find the Abstract Semi-Formal Model (ASFM) and put the .docx file (default to null)
String *key = key_example; // Access key to the PKM (default to null)
InlineObject1 *body = ; // 
Boolean *asynchronous = true; // flag to control asynchronous/synchronous execution of asfm_to_doc job. When invocationID is specified, this flag is implicitely set to false (synchronous execution). (optional) (default to false)
String *invocationID = invocationID_example; // invocation identifier (optional) (optional) (default to null)

[apiInstance asfmToDocWith:dbName
    key:key
    body:body
    asynchronous:asynchronous
    invocationID:invocationID
              completionHandler: ^(Job output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AsfmRestfulApiForPkm = require('asfm_restful_api_for_pkm');

// Create an instance of the API class
var api = new AsfmRestfulApiForPkm.AsfmApi()
var dbName = dbName_example; // {String} The project name where to find the Abstract Semi-Formal Model (ASFM) and put the .docx file
var key = key_example; // {String} Access key to the PKM
var body = ; // {InlineObject1} 
var opts = {
  'asynchronous': true, // {Boolean} flag to control asynchronous/synchronous execution of asfm_to_doc job. When invocationID is specified, this flag is implicitely set to false (synchronous execution).
  'invocationID': invocationID_example // {String} invocation identifier (optional)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.asfmToDoc(dbName, key, body, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class asfmToDocExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new AsfmApi();
            var dbName = dbName_example;  // String | The project name where to find the Abstract Semi-Formal Model (ASFM) and put the .docx file (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new InlineObject1(); // InlineObject1 | 
            var asynchronous = true;  // Boolean | flag to control asynchronous/synchronous execution of asfm_to_doc job. When invocationID is specified, this flag is implicitely set to false (synchronous execution). (optional)  (default to false)
            var invocationID = invocationID_example;  // String | invocation identifier (optional) (optional)  (default to null)

            try {
                Job result = apiInstance.asfmToDoc(dbName, key, body, asynchronous, invocationID);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AsfmApi.asfmToDoc: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AsfmApi();
$dbName = dbName_example; // String | The project name where to find the Abstract Semi-Formal Model (ASFM) and put the .docx file
$key = key_example; // String | Access key to the PKM
$body = ; // InlineObject1 | 
$asynchronous = true; // Boolean | flag to control asynchronous/synchronous execution of asfm_to_doc job. When invocationID is specified, this flag is implicitely set to false (synchronous execution).
$invocationID = invocationID_example; // String | invocation identifier (optional)

try {
    $result = $api_instance->asfmToDoc($dbName, $key, $body, $asynchronous, $invocationID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AsfmApi->asfmToDoc: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AsfmApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AsfmApi->new();
my $dbName = dbName_example; # String | The project name where to find the Abstract Semi-Formal Model (ASFM) and put the .docx file
my $key = key_example; # String | Access key to the PKM
my $body = WWW::OPenAPIClient::Object::InlineObject1->new(); # InlineObject1 | 
my $asynchronous = true; # Boolean | flag to control asynchronous/synchronous execution of asfm_to_doc job. When invocationID is specified, this flag is implicitely set to false (synchronous execution).
my $invocationID = invocationID_example; # String | invocation identifier (optional)

eval {
    my $result = $api_instance->asfmToDoc(dbName => $dbName, key => $key, body => $body, asynchronous => $asynchronous, invocationID => $invocationID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AsfmApi->asfmToDoc: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AsfmApi()
dbName = dbName_example # String | The project name where to find the Abstract Semi-Formal Model (ASFM) and put the .docx file (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # InlineObject1 | 
asynchronous = true # Boolean | flag to control asynchronous/synchronous execution of asfm_to_doc job. When invocationID is specified, this flag is implicitely set to false (synchronous execution). (optional) (default to false)
invocationID = invocationID_example # String | invocation identifier (optional) (optional) (default to null)

try:
    api_response = api_instance.asfm_to_doc(dbName, key, body, asynchronous=asynchronous, invocationID=invocationID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AsfmApi->asfmToDoc: %s\n" % e)
extern crate AsfmApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // InlineObject1
    let asynchronous = true; // Boolean
    let invocationID = invocationID_example; // String

    let mut context = AsfmApi::Context::default();
    let result = client.asfmToDoc(dbName, key, body, asynchronous, invocationID, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
The project name where to find the Abstract Semi-Formal Model (ASFM) and put the .docx file
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Query parameters
Name Description
asynchronous
Boolean
flag to control asynchronous/synchronous execution of asfm_to_doc job. When invocationID is specified, this flag is implicitely set to false (synchronous execution).
invocationID
String
invocation identifier (optional)

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

codeToAsfm

Converts source code Abstract Syntax trees (ASTs) to an Abstract Semi-Formal Model (ASFM)


/asfm/code_to_asfm/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "http://pkm-api_asfm_1:8086/asfm/code_to_asfm/{dbName}?asynchronous=true&invocationID=invocationID_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AsfmApi;

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

public class AsfmApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        AsfmApi apiInstance = new AsfmApi();
        String dbName = dbName_example; // String | The project name where to find the source code Abstract Syntax trees (ASTs) and put the Abstract Semi-Formal Model (ASFM).
        String key = key_example; // String | Access key to the PKM
        Boolean asynchronous = true; // Boolean | flag to control asynchronous/synchronous execution of code_to_asfm job. When invocationID is specified, this flag is implicitely set to false (synchronous execution).
        String invocationID = invocationID_example; // String | invocation identifier (optional)

        try {
            Job result = apiInstance.codeToAsfm(dbName, key, asynchronous, invocationID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AsfmApi#codeToAsfm");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AsfmApi;

public class AsfmApiExample {
    public static void main(String[] args) {
        AsfmApi apiInstance = new AsfmApi();
        String dbName = dbName_example; // String | The project name where to find the source code Abstract Syntax trees (ASTs) and put the Abstract Semi-Formal Model (ASFM).
        String key = key_example; // String | Access key to the PKM
        Boolean asynchronous = true; // Boolean | flag to control asynchronous/synchronous execution of code_to_asfm job. When invocationID is specified, this flag is implicitely set to false (synchronous execution).
        String invocationID = invocationID_example; // String | invocation identifier (optional)

        try {
            Job result = apiInstance.codeToAsfm(dbName, key, asynchronous, invocationID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AsfmApi#codeToAsfm");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AsfmApi *apiInstance = [[AsfmApi alloc] init];
String *dbName = dbName_example; // The project name where to find the source code Abstract Syntax trees (ASTs) and put the Abstract Semi-Formal Model (ASFM). (default to null)
String *key = key_example; // Access key to the PKM (default to null)
Boolean *asynchronous = true; // flag to control asynchronous/synchronous execution of code_to_asfm job. When invocationID is specified, this flag is implicitely set to false (synchronous execution). (optional) (default to false)
String *invocationID = invocationID_example; // invocation identifier (optional) (optional) (default to null)

[apiInstance codeToAsfmWith:dbName
    key:key
    asynchronous:asynchronous
    invocationID:invocationID
              completionHandler: ^(Job output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AsfmRestfulApiForPkm = require('asfm_restful_api_for_pkm');

// Create an instance of the API class
var api = new AsfmRestfulApiForPkm.AsfmApi()
var dbName = dbName_example; // {String} The project name where to find the source code Abstract Syntax trees (ASTs) and put the Abstract Semi-Formal Model (ASFM).
var key = key_example; // {String} Access key to the PKM
var opts = {
  'asynchronous': true, // {Boolean} flag to control asynchronous/synchronous execution of code_to_asfm job. When invocationID is specified, this flag is implicitely set to false (synchronous execution).
  'invocationID': invocationID_example // {String} invocation identifier (optional)
};

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

namespace Example
{
    public class codeToAsfmExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new AsfmApi();
            var dbName = dbName_example;  // String | The project name where to find the source code Abstract Syntax trees (ASTs) and put the Abstract Semi-Formal Model (ASFM). (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var asynchronous = true;  // Boolean | flag to control asynchronous/synchronous execution of code_to_asfm job. When invocationID is specified, this flag is implicitely set to false (synchronous execution). (optional)  (default to false)
            var invocationID = invocationID_example;  // String | invocation identifier (optional) (optional)  (default to null)

            try {
                Job result = apiInstance.codeToAsfm(dbName, key, asynchronous, invocationID);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AsfmApi.codeToAsfm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AsfmApi();
$dbName = dbName_example; // String | The project name where to find the source code Abstract Syntax trees (ASTs) and put the Abstract Semi-Formal Model (ASFM).
$key = key_example; // String | Access key to the PKM
$asynchronous = true; // Boolean | flag to control asynchronous/synchronous execution of code_to_asfm job. When invocationID is specified, this flag is implicitely set to false (synchronous execution).
$invocationID = invocationID_example; // String | invocation identifier (optional)

try {
    $result = $api_instance->codeToAsfm($dbName, $key, $asynchronous, $invocationID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AsfmApi->codeToAsfm: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AsfmApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AsfmApi->new();
my $dbName = dbName_example; # String | The project name where to find the source code Abstract Syntax trees (ASTs) and put the Abstract Semi-Formal Model (ASFM).
my $key = key_example; # String | Access key to the PKM
my $asynchronous = true; # Boolean | flag to control asynchronous/synchronous execution of code_to_asfm job. When invocationID is specified, this flag is implicitely set to false (synchronous execution).
my $invocationID = invocationID_example; # String | invocation identifier (optional)

eval {
    my $result = $api_instance->codeToAsfm(dbName => $dbName, key => $key, asynchronous => $asynchronous, invocationID => $invocationID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AsfmApi->codeToAsfm: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AsfmApi()
dbName = dbName_example # String | The project name where to find the source code Abstract Syntax trees (ASTs) and put the Abstract Semi-Formal Model (ASFM). (default to null)
key = key_example # String | Access key to the PKM (default to null)
asynchronous = true # Boolean | flag to control asynchronous/synchronous execution of code_to_asfm job. When invocationID is specified, this flag is implicitely set to false (synchronous execution). (optional) (default to false)
invocationID = invocationID_example # String | invocation identifier (optional) (optional) (default to null)

try:
    api_response = api_instance.code_to_asfm(dbName, key, asynchronous=asynchronous, invocationID=invocationID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AsfmApi->codeToAsfm: %s\n" % e)
extern crate AsfmApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let asynchronous = true; // Boolean
    let invocationID = invocationID_example; // String

    let mut context = AsfmApi::Context::default();
    let result = client.codeToAsfm(dbName, key, asynchronous, invocationID, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
The project name where to find the source code Abstract Syntax trees (ASTs) and put the Abstract Semi-Formal Model (ASFM).
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Query parameters
Name Description
asynchronous
Boolean
flag to control asynchronous/synchronous execution of code_to_asfm job. When invocationID is specified, this flag is implicitely set to false (synchronous execution).
invocationID
String
invocation identifier (optional)

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

docToAsfm

Converts a Microsoft Office .docx file to an Abstract Semi-Formal Model (ASFM)


/asfm/doc_to_asfm/{dbName}

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://pkm-api_asfm_1:8086/asfm/doc_to_asfm/{dbName}?asynchronous=true&invocationID=invocationID_example" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AsfmApi;

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

public class AsfmApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        AsfmApi apiInstance = new AsfmApi();
        String dbName = dbName_example; // String | The project name where to find the .docx file and put the Abstract Semi-Formal Model (ASFM)
        String key = key_example; // String | Access key to the PKM
        InlineObject body = ; // InlineObject | 
        Boolean asynchronous = true; // Boolean | flag to control asynchronous/synchronous execution of doc_to_asfm job. When invocationID is specified, this flag is implicitely set to false (synchronous execution).
        String invocationID = invocationID_example; // String | invocation identifier (optional)

        try {
            Job result = apiInstance.docToAsfm(dbName, key, body, asynchronous, invocationID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AsfmApi#docToAsfm");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AsfmApi;

public class AsfmApiExample {
    public static void main(String[] args) {
        AsfmApi apiInstance = new AsfmApi();
        String dbName = dbName_example; // String | The project name where to find the .docx file and put the Abstract Semi-Formal Model (ASFM)
        String key = key_example; // String | Access key to the PKM
        InlineObject body = ; // InlineObject | 
        Boolean asynchronous = true; // Boolean | flag to control asynchronous/synchronous execution of doc_to_asfm job. When invocationID is specified, this flag is implicitely set to false (synchronous execution).
        String invocationID = invocationID_example; // String | invocation identifier (optional)

        try {
            Job result = apiInstance.docToAsfm(dbName, key, body, asynchronous, invocationID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AsfmApi#docToAsfm");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AsfmApi *apiInstance = [[AsfmApi alloc] init];
String *dbName = dbName_example; // The project name where to find the .docx file and put the Abstract Semi-Formal Model (ASFM) (default to null)
String *key = key_example; // Access key to the PKM (default to null)
InlineObject *body = ; // 
Boolean *asynchronous = true; // flag to control asynchronous/synchronous execution of doc_to_asfm job. When invocationID is specified, this flag is implicitely set to false (synchronous execution). (optional) (default to false)
String *invocationID = invocationID_example; // invocation identifier (optional) (optional) (default to null)

[apiInstance docToAsfmWith:dbName
    key:key
    body:body
    asynchronous:asynchronous
    invocationID:invocationID
              completionHandler: ^(Job output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AsfmRestfulApiForPkm = require('asfm_restful_api_for_pkm');

// Create an instance of the API class
var api = new AsfmRestfulApiForPkm.AsfmApi()
var dbName = dbName_example; // {String} The project name where to find the .docx file and put the Abstract Semi-Formal Model (ASFM)
var key = key_example; // {String} Access key to the PKM
var body = ; // {InlineObject} 
var opts = {
  'asynchronous': true, // {Boolean} flag to control asynchronous/synchronous execution of doc_to_asfm job. When invocationID is specified, this flag is implicitely set to false (synchronous execution).
  'invocationID': invocationID_example // {String} invocation identifier (optional)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.docToAsfm(dbName, key, body, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class docToAsfmExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new AsfmApi();
            var dbName = dbName_example;  // String | The project name where to find the .docx file and put the Abstract Semi-Formal Model (ASFM) (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)
            var body = new InlineObject(); // InlineObject | 
            var asynchronous = true;  // Boolean | flag to control asynchronous/synchronous execution of doc_to_asfm job. When invocationID is specified, this flag is implicitely set to false (synchronous execution). (optional)  (default to false)
            var invocationID = invocationID_example;  // String | invocation identifier (optional) (optional)  (default to null)

            try {
                Job result = apiInstance.docToAsfm(dbName, key, body, asynchronous, invocationID);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AsfmApi.docToAsfm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AsfmApi();
$dbName = dbName_example; // String | The project name where to find the .docx file and put the Abstract Semi-Formal Model (ASFM)
$key = key_example; // String | Access key to the PKM
$body = ; // InlineObject | 
$asynchronous = true; // Boolean | flag to control asynchronous/synchronous execution of doc_to_asfm job. When invocationID is specified, this flag is implicitely set to false (synchronous execution).
$invocationID = invocationID_example; // String | invocation identifier (optional)

try {
    $result = $api_instance->docToAsfm($dbName, $key, $body, $asynchronous, $invocationID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AsfmApi->docToAsfm: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AsfmApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AsfmApi->new();
my $dbName = dbName_example; # String | The project name where to find the .docx file and put the Abstract Semi-Formal Model (ASFM)
my $key = key_example; # String | Access key to the PKM
my $body = WWW::OPenAPIClient::Object::InlineObject->new(); # InlineObject | 
my $asynchronous = true; # Boolean | flag to control asynchronous/synchronous execution of doc_to_asfm job. When invocationID is specified, this flag is implicitely set to false (synchronous execution).
my $invocationID = invocationID_example; # String | invocation identifier (optional)

eval {
    my $result = $api_instance->docToAsfm(dbName => $dbName, key => $key, body => $body, asynchronous => $asynchronous, invocationID => $invocationID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AsfmApi->docToAsfm: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AsfmApi()
dbName = dbName_example # String | The project name where to find the .docx file and put the Abstract Semi-Formal Model (ASFM) (default to null)
key = key_example # String | Access key to the PKM (default to null)
body =  # InlineObject | 
asynchronous = true # Boolean | flag to control asynchronous/synchronous execution of doc_to_asfm job. When invocationID is specified, this flag is implicitely set to false (synchronous execution). (optional) (default to false)
invocationID = invocationID_example # String | invocation identifier (optional) (optional) (default to null)

try:
    api_response = api_instance.doc_to_asfm(dbName, key, body, asynchronous=asynchronous, invocationID=invocationID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AsfmApi->docToAsfm: %s\n" % e)
extern crate AsfmApi;

pub fn main() {
    let dbName = dbName_example; // String
    let key = key_example; // String
    let body = ; // InlineObject
    let asynchronous = true; // Boolean
    let invocationID = invocationID_example; // String

    let mut context = AsfmApi::Context::default();
    let result = client.docToAsfm(dbName, key, body, asynchronous, invocationID, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
dbName*
String
The project name where to find the .docx file and put the Abstract Semi-Formal Model (ASFM)
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required
Body parameters
Name Description
body *

Query parameters
Name Description
asynchronous
Boolean
flag to control asynchronous/synchronous execution of doc_to_asfm job. When invocationID is specified, this flag is implicitely set to false (synchronous execution).
invocationID
String
invocation identifier (optional)

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

getJob

Get ASFM Job (either doc_to_asfm, asfm_to_doc, or code_to_asfm). Getting a finished or failed job, unpublish it (it is no longer available)


/asfm/jobs/{jobId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://pkm-api_asfm_1:8086/asfm/jobs/{jobId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AsfmApi;

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

public class AsfmApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        AsfmApi apiInstance = new AsfmApi();
        Integer jobId = 56; // Integer | Job identifier
        String key = key_example; // String | Access key to the PKM

        try {
            Job result = apiInstance.getJob(jobId, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AsfmApi#getJob");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AsfmApi;

public class AsfmApiExample {
    public static void main(String[] args) {
        AsfmApi apiInstance = new AsfmApi();
        Integer jobId = 56; // Integer | Job identifier
        String key = key_example; // String | Access key to the PKM

        try {
            Job result = apiInstance.getJob(jobId, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AsfmApi#getJob");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AsfmApi *apiInstance = [[AsfmApi alloc] init];
Integer *jobId = 56; // Job identifier (default to null)
String *key = key_example; // Access key to the PKM (default to null)

[apiInstance getJobWith:jobId
    key:key
              completionHandler: ^(Job output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AsfmRestfulApiForPkm = require('asfm_restful_api_for_pkm');

// Create an instance of the API class
var api = new AsfmRestfulApiForPkm.AsfmApi()
var jobId = 56; // {Integer} Job identifier
var key = key_example; // {String} Access key to the PKM

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

namespace Example
{
    public class getJobExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new AsfmApi();
            var jobId = 56;  // Integer | Job identifier (default to null)
            var key = key_example;  // String | Access key to the PKM (default to null)

            try {
                Job result = apiInstance.getJob(jobId, key);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AsfmApi.getJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AsfmApi();
$jobId = 56; // Integer | Job identifier
$key = key_example; // String | Access key to the PKM

try {
    $result = $api_instance->getJob($jobId, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AsfmApi->getJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AsfmApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AsfmApi->new();
my $jobId = 56; # Integer | Job identifier
my $key = key_example; # String | Access key to the PKM

eval {
    my $result = $api_instance->getJob(jobId => $jobId, key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AsfmApi->getJob: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AsfmApi()
jobId = 56 # Integer | Job identifier (default to null)
key = key_example # String | Access key to the PKM (default to null)

try:
    api_response = api_instance.get_job(jobId, key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AsfmApi->getJob: %s\n" % e)
extern crate AsfmApi;

pub fn main() {
    let jobId = 56; // Integer
    let key = key_example; // String

    let mut context = AsfmApi::Context::default();
    let result = client.getJob(jobId, key, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
jobId*
Integer
Job identifier
Required
Header parameters
Name Description
key*
String
Access key to the PKM
Required

Responses

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String

Name Type Format Description
AccessMinusControlMinusAllowMinusOrigin String
AccessMinusControlMinusAllowMinusMethods String
AccessMinusControlMinusAllowMinusHeaders String