Deyel APIRest

Authorization

getToken

Create and get authorization token.

Create an authorization token, with an expiration date and time, and then return it to be used in the rest of the endpoints. For this use the URL https://miAmbiente.deyel.com/oauth


/token

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
-H "Content-Type: application/x-www-form-urlencoded"\
"https://miAmbiente.deyel.com/v1.0/token"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthorizationApi;

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

public class AuthorizationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AuthorizationApi apiInstance = new AuthorizationApi();
        String grantType = grantType_example; // String | 
        try {
            Token200 result = apiInstance.getToken(grantType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorizationApi#getToken");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthorizationApi;

public class AuthorizationApiExample {

    public static void main(String[] args) {
        AuthorizationApi apiInstance = new AuthorizationApi();
        String grantType = grantType_example; // String | 
        try {
            Token200 result = apiInstance.getToken(grantType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorizationApi#getToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *grantType = grantType_example; // 

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

// Create and get authorization token.
[apiInstance getTokenWith:grantType
              completionHandler: ^(Token200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DeyelApiRest = require('deyel_api_rest');
var defaultClient = DeyelApiRest.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new DeyelApiRest.AuthorizationApi()
var grantType = grantType_example; // {{String}} 

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

namespace Example
{
    public class getTokenExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AuthorizationApi();
            var grantType = grantType_example;  // String | 

            try
            {
                // Create and get authorization token.
                Token200 result = apiInstance.getToken(grantType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthorizationApi.getToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiAuthorizationApi();
$grantType = grantType_example; // String | 

try {
    $result = $api_instance->getToken($grantType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthorizationApi->getToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthorizationApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AuthorizationApi->new();
my $grantType = grantType_example; # String | 

eval { 
    my $result = $api_instance->getToken(grantType => $grantType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthorizationApi->getToken: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AuthorizationApi()
grantType = grantType_example # String | 

try: 
    # Create and get authorization token.
    api_response = api_instance.get_token(grantType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthorizationApi->getToken: %s\n" % e)

Parameters

Form parameters
Name Description
grant_type*
String
Required

Responses

Status: 200 - Token

Status: 400 - The credentials are invalid.


Cases

executeCurrentActivity

Execute a activity (without a button).

Execute the current activity of a case without the execution of a button.


/cases/{idCase}/activities/{cdActivity}/execute

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://miAmbiente.deyel.com/v1.0/cases/{idCase}/activities/{cdActivity}/execute"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CasesApi;

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

public class CasesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        CasesApi apiInstance = new CasesApi();
        ProcessExecute body = ; // ProcessExecute | 
        Long idCase = 789; // Long | Case identification
        Long cdActivity = 789; // Long | Activity identification
        try {
            ActvityStarted result = apiInstance.executeCurrentActivity(body, idCase, cdActivity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CasesApi#executeCurrentActivity");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CasesApi;

public class CasesApiExample {

    public static void main(String[] args) {
        CasesApi apiInstance = new CasesApi();
        ProcessExecute body = ; // ProcessExecute | 
        Long idCase = 789; // Long | Case identification
        Long cdActivity = 789; // Long | Activity identification
        try {
            ActvityStarted result = apiInstance.executeCurrentActivity(body, idCase, cdActivity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CasesApi#executeCurrentActivity");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
ProcessExecute *body = ; // 
Long *idCase = 789; // Case identification
Long *cdActivity = 789; // Activity identification

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

// Execute a activity (without a button).
[apiInstance executeCurrentActivityWith:body
    idCase:idCase
    cdActivity:cdActivity
              completionHandler: ^(ActvityStarted output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DeyelApiRest = require('deyel_api_rest');
var defaultClient = DeyelApiRest.ApiClient.instance;


var api = new DeyelApiRest.CasesApi()
var body = ; // {{ProcessExecute}} 
var idCase = 789; // {{Long}} Case identification
var cdActivity = 789; // {{Long}} Activity identification

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

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


            var apiInstance = new CasesApi();
            var body = new ProcessExecute(); // ProcessExecute | 
            var idCase = 789;  // Long | Case identification
            var cdActivity = 789;  // Long | Activity identification

            try
            {
                // Execute a activity (without a button).
                ActvityStarted result = apiInstance.executeCurrentActivity(body, idCase, cdActivity);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CasesApi.executeCurrentActivity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCasesApi();
$body = ; // ProcessExecute | 
$idCase = 789; // Long | Case identification
$cdActivity = 789; // Long | Activity identification

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


my $api_instance = WWW::SwaggerClient::CasesApi->new();
my $body = WWW::SwaggerClient::Object::ProcessExecute->new(); # ProcessExecute | 
my $idCase = 789; # Long | Case identification
my $cdActivity = 789; # Long | Activity identification

eval { 
    my $result = $api_instance->executeCurrentActivity(body => $body, idCase => $idCase, cdActivity => $cdActivity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CasesApi->executeCurrentActivity: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.CasesApi()
body =  # ProcessExecute | 
idCase = 789 # Long | Case identification
cdActivity = 789 # Long | Activity identification

try: 
    # Execute a activity (without a button).
    api_response = api_instance.execute_current_activity(body, idCase, cdActivity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CasesApi->executeCurrentActivity: %s\n" % e)

Parameters

Path parameters
Name Description
idCase*
Long (int64)
Case identification
Required
cdActivity*
Long (int64)
Activity identification
Required
Body parameters
Name Description
body *

Responses

Status: 202 - “Updated” success code, for PUT request

Status: 304 - The request content has not changed since a specified date and time. The date and time is provided in a If-Modified-Since header. See Get Object Metadata Changes for an example.

Status: 401 - The session ID or OAuth token used has expired or is invalid. The response body contains the message and errorCode.

Status: 403 - The request has been refused. Verify that the logged-in user has appropriate permissions. If the error code is REQUEST_LIMIT_EXCEEDED, you’ve exceeded API request limits in your org.

Status: 404 - The requested resource couldn’t be found. Check the URI for errors, and verify that there are no sharing issues.

Status: 500 - An error has occurred within Deyel Platform, so the request couldn’t be completed.


startCase

Start a case.

The case is created with the start of the first activity.


/cases

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://miAmbiente.deyel.com/v1.0/cases"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CasesApi;

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

public class CasesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        CasesApi apiInstance = new CasesApi();
        StartCase body = ; // StartCase | 
        try {
            CaseCreated result = apiInstance.startCase(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CasesApi#startCase");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CasesApi;

public class CasesApiExample {

    public static void main(String[] args) {
        CasesApi apiInstance = new CasesApi();
        StartCase body = ; // StartCase | 
        try {
            CaseCreated result = apiInstance.startCase(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CasesApi#startCase");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
StartCase *body = ; // 

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

// Start a case.
[apiInstance startCaseWith:body
              completionHandler: ^(CaseCreated output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DeyelApiRest = require('deyel_api_rest');
var defaultClient = DeyelApiRest.ApiClient.instance;


var api = new DeyelApiRest.CasesApi()
var body = ; // {{StartCase}} 

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

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


            var apiInstance = new CasesApi();
            var body = new StartCase(); // StartCase | 

            try
            {
                // Start a case.
                CaseCreated result = apiInstance.startCase(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CasesApi.startCase: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCasesApi();
$body = ; // StartCase | 

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


my $api_instance = WWW::SwaggerClient::CasesApi->new();
my $body = WWW::SwaggerClient::Object::StartCase->new(); # StartCase | 

eval { 
    my $result = $api_instance->startCase(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CasesApi->startCase: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.CasesApi()
body =  # StartCase | 

try: 
    # Start a case.
    api_response = api_instance.start_case(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CasesApi->startCase: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - “Created” success code, for POST request.

Status: 304 - The request content has not changed since a specified date and time. The date and time is provided in a If-Modified-Since header. See Get Object Metadata Changes for an example.

Status: 401 - The session ID or OAuth token used has expired or is invalid. The response body contains the message and errorCode.

Status: 403 - The request has been refused. Verify that the logged-in user has appropriate permissions. If the error code is REQUEST_LIMIT_EXCEEDED, you’ve exceeded API request limits in your org.

Status: 404 - The requested resource couldn’t be found. Check the URI for errors, and verify that there are no sharing issues.

Status: 500 - An error has occurred within Deyel Platform, so the request couldn’t be completed.


Forms

createFormIntance

Create a new form instance.

Add a new instance to the instance collection of a specific form.


/forms/{idForm}/instances

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://miAmbiente.deyel.com/v1.0/forms/{idForm}/instances"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormsApi;

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

public class FormsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        FormsApi apiInstance = new FormsApi();
        InstanceValues body = ; // InstanceValues | 
        String idForm = idForm_example; // String | Form identification
        try {
            InstanceValue result = apiInstance.createFormIntance(body, idForm);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormsApi#createFormIntance");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormsApi;

public class FormsApiExample {

    public static void main(String[] args) {
        FormsApi apiInstance = new FormsApi();
        InstanceValues body = ; // InstanceValues | 
        String idForm = idForm_example; // String | Form identification
        try {
            InstanceValue result = apiInstance.createFormIntance(body, idForm);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormsApi#createFormIntance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
InstanceValues *body = ; // 
String *idForm = idForm_example; // Form identification

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

// Create a new form instance.
[apiInstance createFormIntanceWith:body
    idForm:idForm
              completionHandler: ^(InstanceValue output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DeyelApiRest = require('deyel_api_rest');
var defaultClient = DeyelApiRest.ApiClient.instance;


var api = new DeyelApiRest.FormsApi()
var body = ; // {{InstanceValues}} 
var idForm = idForm_example; // {{String}} Form identification

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

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


            var apiInstance = new FormsApi();
            var body = new InstanceValues(); // InstanceValues | 
            var idForm = idForm_example;  // String | Form identification

            try
            {
                // Create a new form instance.
                InstanceValue result = apiInstance.createFormIntance(body, idForm);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormsApi.createFormIntance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiFormsApi();
$body = ; // InstanceValues | 
$idForm = idForm_example; // String | Form identification

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


my $api_instance = WWW::SwaggerClient::FormsApi->new();
my $body = WWW::SwaggerClient::Object::InstanceValues->new(); # InstanceValues | 
my $idForm = idForm_example; # String | Form identification

eval { 
    my $result = $api_instance->createFormIntance(body => $body, idForm => $idForm);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FormsApi->createFormIntance: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.FormsApi()
body =  # InstanceValues | 
idForm = idForm_example # String | Form identification

try: 
    # Create a new form instance.
    api_response = api_instance.create_form_intance(body, idForm)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FormsApi->createFormIntance: %s\n" % e)

Parameters

Path parameters
Name Description
idForm*
String
Form identification
Required
Body parameters
Name Description
body *

Responses

Status: 201 - “Created” success code, for POST request.

Status: 304 - The request content has not changed since a specified date and time. The date and time is provided in a If-Modified-Since header. See Get Object Metadata Changes for an example.

Status: 401 - The session ID or OAuth token used has expired or is invalid. The response body contains the message and errorCode.

Status: 403 - The request has been refused. Verify that the logged-in user has appropriate permissions. If the error code is REQUEST_LIMIT_EXCEEDED, you’ve exceeded API request limits in your org.

Status: 404 - The requested resource couldn’t be found. Check the URI for errors, and verify that there are no sharing issues.

Status: 500 - An error has occurred within Deyel Platform, so the request couldn’t be completed.


deleteFormIntance

Delete a existing form instance.

Remove an instance of a specific form.


/forms/{idForm}/instances/{idInstance}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://miAmbiente.deyel.com/v1.0/forms/{idForm}/instances/{idInstance}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormsApi;

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

public class FormsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        FormsApi apiInstance = new FormsApi();
        String idForm = idForm_example; // String | Form identification
        Integer idInstance = 56; // Integer | Instance identification
        try {
            apiInstance.deleteFormIntance(idForm, idInstance);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormsApi#deleteFormIntance");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormsApi;

public class FormsApiExample {

    public static void main(String[] args) {
        FormsApi apiInstance = new FormsApi();
        String idForm = idForm_example; // String | Form identification
        Integer idInstance = 56; // Integer | Instance identification
        try {
            apiInstance.deleteFormIntance(idForm, idInstance);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormsApi#deleteFormIntance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *idForm = idForm_example; // Form identification
Integer *idInstance = 56; // Instance identification

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

// Delete a existing form instance.
[apiInstance deleteFormIntanceWith:idForm
    idInstance:idInstance
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DeyelApiRest = require('deyel_api_rest');
var defaultClient = DeyelApiRest.ApiClient.instance;


var api = new DeyelApiRest.FormsApi()
var idForm = idForm_example; // {{String}} Form identification
var idInstance = 56; // {{Integer}} Instance identification

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

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


            var apiInstance = new FormsApi();
            var idForm = idForm_example;  // String | Form identification
            var idInstance = 56;  // Integer | Instance identification

            try
            {
                // Delete a existing form instance.
                apiInstance.deleteFormIntance(idForm, idInstance);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormsApi.deleteFormIntance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiFormsApi();
$idForm = idForm_example; // String | Form identification
$idInstance = 56; // Integer | Instance identification

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


my $api_instance = WWW::SwaggerClient::FormsApi->new();
my $idForm = idForm_example; # String | Form identification
my $idInstance = 56; # Integer | Instance identification

eval { 
    $api_instance->deleteFormIntance(idForm => $idForm, idInstance => $idInstance);
};
if ($@) {
    warn "Exception when calling FormsApi->deleteFormIntance: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.FormsApi()
idForm = idForm_example # String | Form identification
idInstance = 56 # Integer | Instance identification

try: 
    # Delete a existing form instance.
    api_instance.delete_form_intance(idForm, idInstance)
except ApiException as e:
    print("Exception when calling FormsApi->deleteFormIntance: %s\n" % e)

Parameters

Path parameters
Name Description
idForm*
String
Form identification
Required
idInstance*
Integer
Instance identification
Required

Responses

Status: 204 - “No Content” success code, for DELETE request.

Status: 304 - The request content has not changed since a specified date and time. The date and time is provided in a If-Modified-Since header. See Get Object Metadata Changes for an example.

Status: 401 - The session ID or OAuth token used has expired or is invalid. The response body contains the message and errorCode.

Status: 403 - The request has been refused. Verify that the logged-in user has appropriate permissions. If the error code is REQUEST_LIMIT_EXCEEDED, you’ve exceeded API request limits in your org.

Status: 404 - The requested resource couldn’t be found. Check the URI for errors, and verify that there are no sharing issues.

Status: 500 - An error has occurred within Deyel Platform, so the request couldn’t be completed.


getForm

Retrieve form information.

Retrieve information from a specific form..


/forms/{idForm}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://miAmbiente.deyel.com/v1.0/forms/{idForm}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormsApi;

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

public class FormsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        FormsApi apiInstance = new FormsApi();
        String idForm = idForm_example; // String | Form identification
        try {
            Form result = apiInstance.getForm(idForm);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormsApi#getForm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormsApi;

public class FormsApiExample {

    public static void main(String[] args) {
        FormsApi apiInstance = new FormsApi();
        String idForm = idForm_example; // String | Form identification
        try {
            Form result = apiInstance.getForm(idForm);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormsApi#getForm");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *idForm = idForm_example; // Form identification

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

// Retrieve form information.
[apiInstance getFormWith:idForm
              completionHandler: ^(Form output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DeyelApiRest = require('deyel_api_rest');
var defaultClient = DeyelApiRest.ApiClient.instance;


var api = new DeyelApiRest.FormsApi()
var idForm = idForm_example; // {{String}} Form identification

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

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


            var apiInstance = new FormsApi();
            var idForm = idForm_example;  // String | Form identification

            try
            {
                // Retrieve form information.
                Form result = apiInstance.getForm(idForm);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormsApi.getForm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiFormsApi();
$idForm = idForm_example; // String | Form identification

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


my $api_instance = WWW::SwaggerClient::FormsApi->new();
my $idForm = idForm_example; # String | Form identification

eval { 
    my $result = $api_instance->getForm(idForm => $idForm);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FormsApi->getForm: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.FormsApi()
idForm = idForm_example # String | Form identification

try: 
    # Retrieve form information.
    api_response = api_instance.get_form(idForm)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FormsApi->getForm: %s\n" % e)

Parameters

Path parameters
Name Description
idForm*
String
Form identification
Required

Responses

Status: 200 - “OK” success code, for GET or HEAD request.

Status: 304 - The request content has not changed since a specified date and time. The date and time is provided in a If-Modified-Since header. See Get Object Metadata Changes for an example.

Status: 401 - The session ID or OAuth token used has expired or is invalid. The response body contains the message and errorCode.

Status: 403 - The request has been refused. Verify that the logged-in user has appropriate permissions. If the error code is REQUEST_LIMIT_EXCEEDED, you’ve exceeded API request limits in your org.

Status: 404 - The requested resource couldn’t be found. Check the URI for errors, and verify that there are no sharing issues.

Status: 500 - An error has occurred within Deyel Platform, so the request couldn’t be completed.


getFormIntance

Retrieve form instances.

Retrieves the values of the fields of an instance of a specific form with the links for navigation and the methods to update the resource.


/forms/{idForm}/instances/{idInstance}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://miAmbiente.deyel.com/v1.0/forms/{idForm}/instances/{idInstance}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormsApi;

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

public class FormsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        FormsApi apiInstance = new FormsApi();
        String idForm = idForm_example; // String | Form identification
        Integer idInstance = 56; // Integer | Instance identification
        try {
            InstanceValues result = apiInstance.getFormIntance(idForm, idInstance);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormsApi#getFormIntance");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormsApi;

public class FormsApiExample {

    public static void main(String[] args) {
        FormsApi apiInstance = new FormsApi();
        String idForm = idForm_example; // String | Form identification
        Integer idInstance = 56; // Integer | Instance identification
        try {
            InstanceValues result = apiInstance.getFormIntance(idForm, idInstance);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormsApi#getFormIntance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *idForm = idForm_example; // Form identification
Integer *idInstance = 56; // Instance identification

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

// Retrieve form instances.
[apiInstance getFormIntanceWith:idForm
    idInstance:idInstance
              completionHandler: ^(InstanceValues output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DeyelApiRest = require('deyel_api_rest');
var defaultClient = DeyelApiRest.ApiClient.instance;


var api = new DeyelApiRest.FormsApi()
var idForm = idForm_example; // {{String}} Form identification
var idInstance = 56; // {{Integer}} Instance identification

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

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


            var apiInstance = new FormsApi();
            var idForm = idForm_example;  // String | Form identification
            var idInstance = 56;  // Integer | Instance identification

            try
            {
                // Retrieve form instances.
                InstanceValues result = apiInstance.getFormIntance(idForm, idInstance);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormsApi.getFormIntance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiFormsApi();
$idForm = idForm_example; // String | Form identification
$idInstance = 56; // Integer | Instance identification

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


my $api_instance = WWW::SwaggerClient::FormsApi->new();
my $idForm = idForm_example; # String | Form identification
my $idInstance = 56; # Integer | Instance identification

eval { 
    my $result = $api_instance->getFormIntance(idForm => $idForm, idInstance => $idInstance);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FormsApi->getFormIntance: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.FormsApi()
idForm = idForm_example # String | Form identification
idInstance = 56 # Integer | Instance identification

try: 
    # Retrieve form instances.
    api_response = api_instance.get_form_intance(idForm, idInstance)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FormsApi->getFormIntance: %s\n" % e)

Parameters

Path parameters
Name Description
idForm*
String
Form identification
Required
idInstance*
Integer
Instance identification
Required

Responses

Status: 200 - “OK” success code, for GET or HEAD request.<br><br>Returns a sequence with all form (<b>idForm</b>) fields. For example

Status: 304 - The request content has not changed since a specified date and time. The date and time is provided in a If-Modified-Since header. See Get Object Metadata Changes for an example.

Status: 401 - The session ID or OAuth token used has expired or is invalid. The response body contains the message and errorCode.

Status: 403 - The request has been refused. Verify that the logged-in user has appropriate permissions. If the error code is REQUEST_LIMIT_EXCEEDED, you’ve exceeded API request limits in your org.

Status: 404 - The requested resource couldn’t be found. Check the URI for errors, and verify that there are no sharing issues.

Status: 500 - An error has occurred within Deyel Platform, so the request couldn’t be completed.


getFormIntances

Retrieve form instances.

Retrieves a collection with the values of the fields of a specific form with the links for navigation and the methods of updating the resource.


/forms/{idForm}/instances

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://miAmbiente.deyel.com/v1.0/forms/{idForm}/instances?search=&page-number=&per-page=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormsApi;

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

public class FormsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        FormsApi apiInstance = new FormsApi();
        String idForm = idForm_example; // String | Form identification
        String search = search_example; // String | Search criteria (search=fieldName=operator:value{[,fieldName=operator:value]})
        Integer pageNumber = 56; // Integer | Page number
        Integer perPage = 56; // Integer | Page size
        String sort = sort_example; // String | Sort criteria (sort=[+/-]fieldName{[,[+/-]fieldName]})
        try {
            FormInstances result = apiInstance.getFormIntances(idForm, search, pageNumber, perPage, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormsApi#getFormIntances");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormsApi;

public class FormsApiExample {

    public static void main(String[] args) {
        FormsApi apiInstance = new FormsApi();
        String idForm = idForm_example; // String | Form identification
        String search = search_example; // String | Search criteria (search=fieldName=operator:value{[,fieldName=operator:value]})
        Integer pageNumber = 56; // Integer | Page number
        Integer perPage = 56; // Integer | Page size
        String sort = sort_example; // String | Sort criteria (sort=[+/-]fieldName{[,[+/-]fieldName]})
        try {
            FormInstances result = apiInstance.getFormIntances(idForm, search, pageNumber, perPage, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormsApi#getFormIntances");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *idForm = idForm_example; // Form identification
String *search = search_example; // Search criteria (search=fieldName=operator:value{[,fieldName=operator:value]}) (optional)
Integer *pageNumber = 56; // Page number (optional)
Integer *perPage = 56; // Page size (optional)
String *sort = sort_example; // Sort criteria (sort=[+/-]fieldName{[,[+/-]fieldName]}) (optional)

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

// Retrieve form instances.
[apiInstance getFormIntancesWith:idForm
    search:search
    pageNumber:pageNumber
    perPage:perPage
    sort:sort
              completionHandler: ^(FormInstances output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DeyelApiRest = require('deyel_api_rest');
var defaultClient = DeyelApiRest.ApiClient.instance;


var api = new DeyelApiRest.FormsApi()
var idForm = idForm_example; // {{String}} Form identification
var opts = { 
  'search': search_example, // {{String}} Search criteria (search=fieldName=operator:value{[,fieldName=operator:value]})
  'pageNumber': 56, // {{Integer}} Page number
  'perPage': 56, // {{Integer}} Page size
  'sort': sort_example // {{String}} Sort criteria (sort=[+/-]fieldName{[,[+/-]fieldName]})
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFormIntances(idForm, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new FormsApi();
            var idForm = idForm_example;  // String | Form identification
            var search = search_example;  // String | Search criteria (search=fieldName=operator:value{[,fieldName=operator:value]}) (optional) 
            var pageNumber = 56;  // Integer | Page number (optional) 
            var perPage = 56;  // Integer | Page size (optional) 
            var sort = sort_example;  // String | Sort criteria (sort=[+/-]fieldName{[,[+/-]fieldName]}) (optional) 

            try
            {
                // Retrieve form instances.
                FormInstances result = apiInstance.getFormIntances(idForm, search, pageNumber, perPage, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormsApi.getFormIntances: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiFormsApi();
$idForm = idForm_example; // String | Form identification
$search = search_example; // String | Search criteria (search=fieldName=operator:value{[,fieldName=operator:value]})
$pageNumber = 56; // Integer | Page number
$perPage = 56; // Integer | Page size
$sort = sort_example; // String | Sort criteria (sort=[+/-]fieldName{[,[+/-]fieldName]})

try {
    $result = $api_instance->getFormIntances($idForm, $search, $pageNumber, $perPage, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FormsApi->getFormIntances: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FormsApi;


my $api_instance = WWW::SwaggerClient::FormsApi->new();
my $idForm = idForm_example; # String | Form identification
my $search = search_example; # String | Search criteria (search=fieldName=operator:value{[,fieldName=operator:value]})
my $pageNumber = 56; # Integer | Page number
my $perPage = 56; # Integer | Page size
my $sort = sort_example; # String | Sort criteria (sort=[+/-]fieldName{[,[+/-]fieldName]})

eval { 
    my $result = $api_instance->getFormIntances(idForm => $idForm, search => $search, pageNumber => $pageNumber, perPage => $perPage, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FormsApi->getFormIntances: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.FormsApi()
idForm = idForm_example # String | Form identification
search = search_example # String | Search criteria (search=fieldName=operator:value{[,fieldName=operator:value]}) (optional)
pageNumber = 56 # Integer | Page number (optional)
perPage = 56 # Integer | Page size (optional)
sort = sort_example # String | Sort criteria (sort=[+/-]fieldName{[,[+/-]fieldName]}) (optional)

try: 
    # Retrieve form instances.
    api_response = api_instance.get_form_intances(idForm, search=search, pageNumber=pageNumber, perPage=perPage, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FormsApi->getFormIntances: %s\n" % e)

Parameters

Path parameters
Name Description
idForm*
String
Form identification
Required
Query parameters
Name Description
search
page-number
Integer
Page number
per-page
Integer
Page size
sort
String
Sort criteria (sort=[+/-]fieldName{[,[+/-]fieldName]})

Responses

Status: 200 - “OK” success code, for GET or HEAD request.

Status: 304 - The request content has not changed since a specified date and time. The date and time is provided in a If-Modified-Since header. See Get Object Metadata Changes for an example.

Status: 401 - The session ID or OAuth token used has expired or is invalid. The response body contains the message and errorCode.

Status: 403 - The request has been refused. Verify that the logged-in user has appropriate permissions. If the error code is REQUEST_LIMIT_EXCEEDED, you’ve exceeded API request limits in your org.

Status: 404 - The requested resource couldn’t be found. Check the URI for errors, and verify that there are no sharing issues.

Status: 500 - An error has occurred within Deyel Platform, so the request couldn’t be completed.


getForms

Retrieve forms information..

Retrieves the information from the forms defined in DEYEL..


/forms

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://miAmbiente.deyel.com/v1.0/forms?search=&page-number=&per-page=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormsApi;

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

public class FormsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        FormsApi apiInstance = new FormsApi();
        String search = search_example; // String | Search criteria (search=fieldName=operator:value{[,fieldName=operator:value]})
        Integer pageNumber = 56; // Integer | Page number
        Integer perPage = 56; // Integer | Page size
        String sort = sort_example; // String | Sort criteria (sort=[+/-]fieldName{[,[+/-]fieldName]})
        try {
            Forms result = apiInstance.getForms(search, pageNumber, perPage, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormsApi#getForms");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormsApi;

public class FormsApiExample {

    public static void main(String[] args) {
        FormsApi apiInstance = new FormsApi();
        String search = search_example; // String | Search criteria (search=fieldName=operator:value{[,fieldName=operator:value]})
        Integer pageNumber = 56; // Integer | Page number
        Integer perPage = 56; // Integer | Page size
        String sort = sort_example; // String | Sort criteria (sort=[+/-]fieldName{[,[+/-]fieldName]})
        try {
            Forms result = apiInstance.getForms(search, pageNumber, perPage, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormsApi#getForms");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *search = search_example; // Search criteria (search=fieldName=operator:value{[,fieldName=operator:value]}) (optional)
Integer *pageNumber = 56; // Page number (optional)
Integer *perPage = 56; // Page size (optional)
String *sort = sort_example; // Sort criteria (sort=[+/-]fieldName{[,[+/-]fieldName]}) (optional)

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

// Retrieve forms information..
[apiInstance getFormsWith:search
    pageNumber:pageNumber
    perPage:perPage
    sort:sort
              completionHandler: ^(Forms output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DeyelApiRest = require('deyel_api_rest');
var defaultClient = DeyelApiRest.ApiClient.instance;


var api = new DeyelApiRest.FormsApi()
var opts = { 
  'search': search_example, // {{String}} Search criteria (search=fieldName=operator:value{[,fieldName=operator:value]})
  'pageNumber': 56, // {{Integer}} Page number
  'perPage': 56, // {{Integer}} Page size
  'sort': sort_example // {{String}} Sort criteria (sort=[+/-]fieldName{[,[+/-]fieldName]})
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getForms(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new FormsApi();
            var search = search_example;  // String | Search criteria (search=fieldName=operator:value{[,fieldName=operator:value]}) (optional) 
            var pageNumber = 56;  // Integer | Page number (optional) 
            var perPage = 56;  // Integer | Page size (optional) 
            var sort = sort_example;  // String | Sort criteria (sort=[+/-]fieldName{[,[+/-]fieldName]}) (optional) 

            try
            {
                // Retrieve forms information..
                Forms result = apiInstance.getForms(search, pageNumber, perPage, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormsApi.getForms: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiFormsApi();
$search = search_example; // String | Search criteria (search=fieldName=operator:value{[,fieldName=operator:value]})
$pageNumber = 56; // Integer | Page number
$perPage = 56; // Integer | Page size
$sort = sort_example; // String | Sort criteria (sort=[+/-]fieldName{[,[+/-]fieldName]})

try {
    $result = $api_instance->getForms($search, $pageNumber, $perPage, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FormsApi->getForms: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FormsApi;


my $api_instance = WWW::SwaggerClient::FormsApi->new();
my $search = search_example; # String | Search criteria (search=fieldName=operator:value{[,fieldName=operator:value]})
my $pageNumber = 56; # Integer | Page number
my $perPage = 56; # Integer | Page size
my $sort = sort_example; # String | Sort criteria (sort=[+/-]fieldName{[,[+/-]fieldName]})

eval { 
    my $result = $api_instance->getForms(search => $search, pageNumber => $pageNumber, perPage => $perPage, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FormsApi->getForms: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.FormsApi()
search = search_example # String | Search criteria (search=fieldName=operator:value{[,fieldName=operator:value]}) (optional)
pageNumber = 56 # Integer | Page number (optional)
perPage = 56 # Integer | Page size (optional)
sort = sort_example # String | Sort criteria (sort=[+/-]fieldName{[,[+/-]fieldName]}) (optional)

try: 
    # Retrieve forms information..
    api_response = api_instance.get_forms(search=search, pageNumber=pageNumber, perPage=perPage, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FormsApi->getForms: %s\n" % e)

Parameters

Query parameters
Name Description
search
page-number
Integer
Page number
per-page
Integer
Page size
sort
String
Sort criteria (sort=[+/-]fieldName{[,[+/-]fieldName]})

Responses

Status: 200 - “OK” success code, for GET or HEAD request.

Status: 304 - The request content has not changed since a specified date and time. The date and time is provided in a If-Modified-Since header. See Get Object Metadata Changes for an example.

Status: 401 - The session ID or OAuth token used has expired or is invalid. The response body contains the message and errorCode.

Status: 403 - The request has been refused. Verify that the logged-in user has appropriate permissions. If the error code is REQUEST_LIMIT_EXCEEDED, you’ve exceeded API request limits in your org.

Status: 404 - The requested resource couldn’t be found. Check the URI for errors, and verify that there are no sharing issues.

Status: 500 - An error has occurred within Deyel Platform, so the request couldn’t be completed.


updateFormIntance

Update a existing form instance.

Update all or some of the field values of an instance of a specific form.


/forms/{idForm}/instances/{idInstance}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://miAmbiente.deyel.com/v1.0/forms/{idForm}/instances/{idInstance}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormsApi;

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

public class FormsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        FormsApi apiInstance = new FormsApi();
        InstanceValues body = ; // InstanceValues | 
        String idForm = idForm_example; // String | Form identification
        Integer idInstance = 56; // Integer | Instance identification
        try {
            apiInstance.updateFormIntance(body, idForm, idInstance);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormsApi#updateFormIntance");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormsApi;

public class FormsApiExample {

    public static void main(String[] args) {
        FormsApi apiInstance = new FormsApi();
        InstanceValues body = ; // InstanceValues | 
        String idForm = idForm_example; // String | Form identification
        Integer idInstance = 56; // Integer | Instance identification
        try {
            apiInstance.updateFormIntance(body, idForm, idInstance);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormsApi#updateFormIntance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
InstanceValues *body = ; // 
String *idForm = idForm_example; // Form identification
Integer *idInstance = 56; // Instance identification

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

// Update a existing form instance.
[apiInstance updateFormIntanceWith:body
    idForm:idForm
    idInstance:idInstance
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DeyelApiRest = require('deyel_api_rest');
var defaultClient = DeyelApiRest.ApiClient.instance;


var api = new DeyelApiRest.FormsApi()
var body = ; // {{InstanceValues}} 
var idForm = idForm_example; // {{String}} Form identification
var idInstance = 56; // {{Integer}} Instance identification

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

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


            var apiInstance = new FormsApi();
            var body = new InstanceValues(); // InstanceValues | 
            var idForm = idForm_example;  // String | Form identification
            var idInstance = 56;  // Integer | Instance identification

            try
            {
                // Update a existing form instance.
                apiInstance.updateFormIntance(body, idForm, idInstance);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormsApi.updateFormIntance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiFormsApi();
$body = ; // InstanceValues | 
$idForm = idForm_example; // String | Form identification
$idInstance = 56; // Integer | Instance identification

try {
    $api_instance->updateFormIntance($body, $idForm, $idInstance);
} catch (Exception $e) {
    echo 'Exception when calling FormsApi->updateFormIntance: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FormsApi;


my $api_instance = WWW::SwaggerClient::FormsApi->new();
my $body = WWW::SwaggerClient::Object::InstanceValues->new(); # InstanceValues | 
my $idForm = idForm_example; # String | Form identification
my $idInstance = 56; # Integer | Instance identification

eval { 
    $api_instance->updateFormIntance(body => $body, idForm => $idForm, idInstance => $idInstance);
};
if ($@) {
    warn "Exception when calling FormsApi->updateFormIntance: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.FormsApi()
body =  # InstanceValues | 
idForm = idForm_example # String | Form identification
idInstance = 56 # Integer | Instance identification

try: 
    # Update a existing form instance.
    api_instance.update_form_intance(body, idForm, idInstance)
except ApiException as e:
    print("Exception when calling FormsApi->updateFormIntance: %s\n" % e)

Parameters

Path parameters
Name Description
idForm*
String
Form identification
Required
idInstance*
Integer
Instance identification
Required
Body parameters
Name Description
body *

Responses

Status: 202 - “Updated” success code, for PUT request

Status: 304 - The request content has not changed since a specified date and time. The date and time is provided in a If-Modified-Since header. See Get Object Metadata Changes for an example.

Status: 401 - The session ID or OAuth token used has expired or is invalid. The response body contains the message and errorCode.

Status: 403 - The request has been refused. Verify that the logged-in user has appropriate permissions. If the error code is REQUEST_LIMIT_EXCEEDED, you’ve exceeded API request limits in your org.

Status: 404 - The requested resource couldn’t be found. Check the URI for errors, and verify that there are no sharing issues.

Status: 500 - An error has occurred within Deyel Platform, so the request couldn’t be completed.


updateValuesOfFormIntance

Update a existing form instance.

Update some of the field values of an instance of a specific form.


/forms/{idForm}/instances/{idInstance}

Usage and SDK Samples

curl -X PATCH\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://miAmbiente.deyel.com/v1.0/forms/{idForm}/instances/{idInstance}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormsApi;

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

public class FormsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        FormsApi apiInstance = new FormsApi();
        InstanceIn body = ; // InstanceIn | 
        String idForm = idForm_example; // String | Form identification
        Integer idInstance = 56; // Integer | Instance identification
        try {
            apiInstance.updateValuesOfFormIntance(body, idForm, idInstance);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormsApi#updateValuesOfFormIntance");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormsApi;

public class FormsApiExample {

    public static void main(String[] args) {
        FormsApi apiInstance = new FormsApi();
        InstanceIn body = ; // InstanceIn | 
        String idForm = idForm_example; // String | Form identification
        Integer idInstance = 56; // Integer | Instance identification
        try {
            apiInstance.updateValuesOfFormIntance(body, idForm, idInstance);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormsApi#updateValuesOfFormIntance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
InstanceIn *body = ; // 
String *idForm = idForm_example; // Form identification
Integer *idInstance = 56; // Instance identification

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

// Update a existing form instance.
[apiInstance updateValuesOfFormIntanceWith:body
    idForm:idForm
    idInstance:idInstance
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DeyelApiRest = require('deyel_api_rest');
var defaultClient = DeyelApiRest.ApiClient.instance;


var api = new DeyelApiRest.FormsApi()
var body = ; // {{InstanceIn}} 
var idForm = idForm_example; // {{String}} Form identification
var idInstance = 56; // {{Integer}} Instance identification

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

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


            var apiInstance = new FormsApi();
            var body = new InstanceIn(); // InstanceIn | 
            var idForm = idForm_example;  // String | Form identification
            var idInstance = 56;  // Integer | Instance identification

            try
            {
                // Update a existing form instance.
                apiInstance.updateValuesOfFormIntance(body, idForm, idInstance);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormsApi.updateValuesOfFormIntance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiFormsApi();
$body = ; // InstanceIn | 
$idForm = idForm_example; // String | Form identification
$idInstance = 56; // Integer | Instance identification

try {
    $api_instance->updateValuesOfFormIntance($body, $idForm, $idInstance);
} catch (Exception $e) {
    echo 'Exception when calling FormsApi->updateValuesOfFormIntance: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FormsApi;


my $api_instance = WWW::SwaggerClient::FormsApi->new();
my $body = WWW::SwaggerClient::Object::InstanceIn->new(); # InstanceIn | 
my $idForm = idForm_example; # String | Form identification
my $idInstance = 56; # Integer | Instance identification

eval { 
    $api_instance->updateValuesOfFormIntance(body => $body, idForm => $idForm, idInstance => $idInstance);
};
if ($@) {
    warn "Exception when calling FormsApi->updateValuesOfFormIntance: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.FormsApi()
body =  # InstanceIn | 
idForm = idForm_example # String | Form identification
idInstance = 56 # Integer | Instance identification

try: 
    # Update a existing form instance.
    api_instance.update_values_of_form_intance(body, idForm, idInstance)
except ApiException as e:
    print("Exception when calling FormsApi->updateValuesOfFormIntance: %s\n" % e)

Parameters

Path parameters
Name Description
idForm*
String
Form identification
Required
idInstance*
Integer
Instance identification
Required
Body parameters
Name Description
body *

Responses

Status: 202 - “Updated” success code, for PUT request

Status: 304 - The request content has not changed since a specified date and time. The date and time is provided in a If-Modified-Since header. See Get Object Metadata Changes for an example.

Status: 401 - The session ID or OAuth token used has expired or is invalid. The response body contains the message and errorCode.

Status: 403 - The request has been refused. Verify that the logged-in user has appropriate permissions. If the error code is REQUEST_LIMIT_EXCEEDED, you’ve exceeded API request limits in your org.

Status: 404 - The requested resource couldn’t be found. Check the URI for errors, and verify that there are no sharing issues.

Status: 500 - An error has occurred within Deyel Platform, so the request couldn’t be completed.


Rules

execute

Execute a rule.

Execute of a specific rule, sending the values of the inputs parameters.


/rules/{cdComponent}-{cdVersion}/execute

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://miAmbiente.deyel.com/v1.0/rules/{cdComponent}-{cdVersion}/execute"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RulesApi;

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

public class RulesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        RulesApi apiInstance = new RulesApi();
        ParametersList body = ; // ParametersList | List of input parameters with parameter name and parameter type
        String cdComponent = cdComponent_example; // String | Rule identification
        String cdVersion = cdVersion_example; // String | Rule version
        try {
            ParametersList result = apiInstance.execute(body, cdComponent, cdVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RulesApi#execute");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RulesApi;

public class RulesApiExample {

    public static void main(String[] args) {
        RulesApi apiInstance = new RulesApi();
        ParametersList body = ; // ParametersList | List of input parameters with parameter name and parameter type
        String cdComponent = cdComponent_example; // String | Rule identification
        String cdVersion = cdVersion_example; // String | Rule version
        try {
            ParametersList result = apiInstance.execute(body, cdComponent, cdVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RulesApi#execute");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
ParametersList *body = ; // List of input parameters with parameter name and parameter type
String *cdComponent = cdComponent_example; // Rule identification
String *cdVersion = cdVersion_example; // Rule version

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

// Execute a rule.
[apiInstance executeWith:body
    cdComponent:cdComponent
    cdVersion:cdVersion
              completionHandler: ^(ParametersList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DeyelApiRest = require('deyel_api_rest');
var defaultClient = DeyelApiRest.ApiClient.instance;


var api = new DeyelApiRest.RulesApi()
var body = ; // {{ParametersList}} List of input parameters with parameter name and parameter type
var cdComponent = cdComponent_example; // {{String}} Rule identification
var cdVersion = cdVersion_example; // {{String}} Rule version

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

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


            var apiInstance = new RulesApi();
            var body = new ParametersList(); // ParametersList | List of input parameters with parameter name and parameter type
            var cdComponent = cdComponent_example;  // String | Rule identification
            var cdVersion = cdVersion_example;  // String | Rule version

            try
            {
                // Execute a rule.
                ParametersList result = apiInstance.execute(body, cdComponent, cdVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RulesApi.execute: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiRulesApi();
$body = ; // ParametersList | List of input parameters with parameter name and parameter type
$cdComponent = cdComponent_example; // String | Rule identification
$cdVersion = cdVersion_example; // String | Rule version

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


my $api_instance = WWW::SwaggerClient::RulesApi->new();
my $body = WWW::SwaggerClient::Object::ParametersList->new(); # ParametersList | List of input parameters with parameter name and parameter type
my $cdComponent = cdComponent_example; # String | Rule identification
my $cdVersion = cdVersion_example; # String | Rule version

eval { 
    my $result = $api_instance->execute(body => $body, cdComponent => $cdComponent, cdVersion => $cdVersion);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RulesApi->execute: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.RulesApi()
body =  # ParametersList | List of input parameters with parameter name and parameter type
cdComponent = cdComponent_example # String | Rule identification
cdVersion = cdVersion_example # String | Rule version

try: 
    # Execute a rule.
    api_response = api_instance.execute(body, cdComponent, cdVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RulesApi->execute: %s\n" % e)

Parameters

Path parameters
Name Description
cdComponent*
String
Rule identification
Required
cdVersion*
String
Rule version
Required
Body parameters
Name Description
body *

Responses

Status: 200 - “OK” success code, for PUT request. Return list of parameters of output, with name parameter and type parameter

Status: 400 - The rule not exist, not published or is not published as Deploy Api Rest.

Status: 401 - The session ID or OAuth token used has expired or is invalid. The response body contains the message and errorCode.

Status: 403 - The request has been refused. Verify that the logged-in user has appropriate permissions. If the error code is REQUEST_LIMIT_EXCEEDED, you’ve exceeded API request limits in your org.

Status: 404 - The requested resource couldn’t be found. Check the URI for errors, and verify that there are no sharing issues.

Status: 500 - An error has occurred within Deyel Platform, so the request couldn’t be completed.


getParameters

Retrieve rule information.

Gets the rule name, version, descriptive name and the list of input parameters with the parameter name and the parameter type.


/rules/{cdComponent}-{cdVersion}/get-parameters

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://miAmbiente.deyel.com/v1.0/rules/{cdComponent}-{cdVersion}/get-parameters"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RulesApi;

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

public class RulesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        RulesApi apiInstance = new RulesApi();
        String cdComponent = cdComponent_example; // String | Rule identification
        String cdVersion = cdVersion_example; // String | Rule version
        try {
            GetParameters result = apiInstance.getParameters(cdComponent, cdVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RulesApi#getParameters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RulesApi;

public class RulesApiExample {

    public static void main(String[] args) {
        RulesApi apiInstance = new RulesApi();
        String cdComponent = cdComponent_example; // String | Rule identification
        String cdVersion = cdVersion_example; // String | Rule version
        try {
            GetParameters result = apiInstance.getParameters(cdComponent, cdVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RulesApi#getParameters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *cdComponent = cdComponent_example; // Rule identification
String *cdVersion = cdVersion_example; // Rule version

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

// Retrieve rule information.
[apiInstance getParametersWith:cdComponent
    cdVersion:cdVersion
              completionHandler: ^(GetParameters output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DeyelApiRest = require('deyel_api_rest');
var defaultClient = DeyelApiRest.ApiClient.instance;


var api = new DeyelApiRest.RulesApi()
var cdComponent = cdComponent_example; // {{String}} Rule identification
var cdVersion = cdVersion_example; // {{String}} Rule version

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

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


            var apiInstance = new RulesApi();
            var cdComponent = cdComponent_example;  // String | Rule identification
            var cdVersion = cdVersion_example;  // String | Rule version

            try
            {
                // Retrieve rule information.
                GetParameters result = apiInstance.getParameters(cdComponent, cdVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RulesApi.getParameters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiRulesApi();
$cdComponent = cdComponent_example; // String | Rule identification
$cdVersion = cdVersion_example; // String | Rule version

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


my $api_instance = WWW::SwaggerClient::RulesApi->new();
my $cdComponent = cdComponent_example; # String | Rule identification
my $cdVersion = cdVersion_example; # String | Rule version

eval { 
    my $result = $api_instance->getParameters(cdComponent => $cdComponent, cdVersion => $cdVersion);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RulesApi->getParameters: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.RulesApi()
cdComponent = cdComponent_example # String | Rule identification
cdVersion = cdVersion_example # String | Rule version

try: 
    # Retrieve rule information.
    api_response = api_instance.get_parameters(cdComponent, cdVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RulesApi->getParameters: %s\n" % e)

Parameters

Path parameters
Name Description
cdComponent*
String
Rule identification
Required
cdVersion*
String
Rule version
Required

Responses

Status: 200 - “OK” success code, for PUT request

Status: 400 - The rule not exist, not published or is not published as Deploy Api Rest.

Status: 401 - The session ID or OAuth token used has expired or is invalid. The response body contains the message and errorCode.

Status: 403 - The request has been refused. Verify that the logged-in user has appropriate permissions. If the error code is REQUEST_LIMIT_EXCEEDED, you’ve exceeded API request limits in your org.

Status: 404 - The requested resource couldn’t be found. Check the URI for errors, and verify that there are no sharing issues.

Status: 500 - An error has occurred within Deyel Platform, so the request couldn’t be completed.