DEYEL application

Default

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 "https://tuservicio.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.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: application
        OAuth application = (OAuth) defaultClient.getAuthentication("application");
        application.setAccessToken("YOUR ACCESS TOKEN");

        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Authorization token obtained with POST /token
        String accept = accept_example; // String | 
        String contentType = contentType_example; // String | 
        String idForm = idForm_example; // String | Form identification
        InstanceValues body = ; // InstanceValues | 
        try {
            InstanceValue result = apiInstance.createFormIntance(authorization, accept, contentType, idForm, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#createFormIntance");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Authorization token obtained with POST /token
        String accept = accept_example; // String | 
        String contentType = contentType_example; // String | 
        String idForm = idForm_example; // String | Form identification
        InstanceValues body = ; // InstanceValues | 
        try {
            InstanceValue result = apiInstance.createFormIntance(authorization, accept, contentType, idForm, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#createFormIntance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: application)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // Authorization token obtained with POST /token
String *accept = accept_example; // 
String *contentType = contentType_example; // 
String *idForm = idForm_example; // Form identification
InstanceValues *body = ; // 

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

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

// Configure OAuth2 access token for authorization: application
var application = defaultClient.authentications['application'];
application.accessToken = "YOUR ACCESS TOKEN"

var api = new DeyelApplication.DefaultApi()

var authorization = authorization_example; // {String} Authorization token obtained with POST /token

var accept = accept_example; // {String} 

var contentType = contentType_example; // {String} 

var idForm = idForm_example; // {String} Form identification

var body = ; // {InstanceValues} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createFormIntance(authorization, accept, contentType, idForm, body, 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()
        {
            
            // Configure OAuth2 access token for authorization: application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DefaultApi();
            var authorization = authorization_example;  // String | Authorization token obtained with POST /token
            var accept = accept_example;  // String | 
            var contentType = contentType_example;  // String | 
            var idForm = idForm_example;  // String | Form identification
            var body = new InstanceValues(); // InstanceValues | 

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

// Configure OAuth2 access token for authorization: application
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DefaultApi();
$authorization = authorization_example; // String | Authorization token obtained with POST /token
$accept = accept_example; // String | 
$contentType = contentType_example; // String | 
$idForm = idForm_example; // String | Form identification
$body = ; // InstanceValues | 

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

# Configure OAuth2 access token for authorization: application
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $authorization = authorization_example; # String | Authorization token obtained with POST /token
my $accept = accept_example; # String | 
my $contentType = contentType_example; # String | 
my $idForm = idForm_example; # String | Form identification
my $body = WWW::SwaggerClient::Object::InstanceValues->new(); # InstanceValues | 

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

# Configure OAuth2 access token for authorization: application
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = authorization_example # String | Authorization token obtained with POST /token
accept = accept_example # String | 
contentType = contentType_example # String | 
idForm = idForm_example # String | Form identification
body =  # InstanceValues | 

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

Parameters

Path parameters
Name Description
idForm*
String
Form identification
Required
Header parameters
Name Description
Authorization*
String
Authorization token obtained with <b>POST /token</b>
Required
Accept*
String
Required
Content-Type*
String
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. Contact Salesforce Customer Support.


deleteFormIntance

Delete a existing form instance.

Remove an instance of a specific form.


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

Usage and SDK Samples

curl -X DELETE "https://tuservicio.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.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: application
        OAuth application = (OAuth) defaultClient.getAuthentication("application");
        application.setAccessToken("YOUR ACCESS TOKEN");

        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Authorization token obtained with POST /token
        String accept = accept_example; // String | 
        String contentType = contentType_example; // String | 
        String idForm = idForm_example; // String | Form identification
        Integer idInstance = 56; // Integer | Instance identification
        try {
            apiInstance.deleteFormIntance(authorization, accept, contentType, idForm, idInstance);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deleteFormIntance");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Authorization token obtained with POST /token
        String accept = accept_example; // String | 
        String contentType = contentType_example; // String | 
        String idForm = idForm_example; // String | Form identification
        Integer idInstance = 56; // Integer | Instance identification
        try {
            apiInstance.deleteFormIntance(authorization, accept, contentType, idForm, idInstance);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deleteFormIntance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: application)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // Authorization token obtained with POST /token
String *accept = accept_example; // 
String *contentType = contentType_example; // 
String *idForm = idForm_example; // Form identification
Integer *idInstance = 56; // Instance identification

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

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

// Configure OAuth2 access token for authorization: application
var application = defaultClient.authentications['application'];
application.accessToken = "YOUR ACCESS TOKEN"

var api = new DeyelApplication.DefaultApi()

var authorization = authorization_example; // {String} Authorization token obtained with POST /token

var accept = accept_example; // {String} 

var contentType = contentType_example; // {String} 

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(authorization, accept, contentType, 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()
        {
            
            // Configure OAuth2 access token for authorization: application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DefaultApi();
            var authorization = authorization_example;  // String | Authorization token obtained with POST /token
            var accept = accept_example;  // String | 
            var contentType = contentType_example;  // String | 
            var idForm = idForm_example;  // String | Form identification
            var idInstance = 56;  // Integer | Instance identification

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

// Configure OAuth2 access token for authorization: application
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DefaultApi();
$authorization = authorization_example; // String | Authorization token obtained with POST /token
$accept = accept_example; // String | 
$contentType = contentType_example; // String | 
$idForm = idForm_example; // String | Form identification
$idInstance = 56; // Integer | Instance identification

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

# Configure OAuth2 access token for authorization: application
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $authorization = authorization_example; # String | Authorization token obtained with POST /token
my $accept = accept_example; # String | 
my $contentType = contentType_example; # String | 
my $idForm = idForm_example; # String | Form identification
my $idInstance = 56; # Integer | Instance identification

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

# Configure OAuth2 access token for authorization: application
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = authorization_example # String | Authorization token obtained with POST /token
accept = accept_example # String | 
contentType = contentType_example # String | 
idForm = idForm_example # String | Form identification
idInstance = 56 # Integer | Instance identification

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

Parameters

Path parameters
Name Description
idForm*
String
Form identification
Required
idInstance*
Integer
Instance identification
Required
Header parameters
Name Description
Authorization*
String
Authorization token obtained with <b>POST /token</b>
Required
Accept*
String
Required
Content-Type*
String
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. Contact Salesforce Customer Support.


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 "https://tuservicio.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.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: application
        OAuth application = (OAuth) defaultClient.getAuthentication("application");
        application.setAccessToken("YOUR ACCESS TOKEN");

        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Authorization token obtained with POST /token
        String accept = accept_example; // String | 
        String contentType = contentType_example; // String | 
        Long idCase = 789; // Long | Case identification
        Long cdActivity = 789; // Long | Activity identification
        ProcessExecute body = ; // ProcessExecute | 
        try {
            ActvityStarted result = apiInstance.executeCurrentActivity(authorization, accept, contentType, idCase, cdActivity, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#executeCurrentActivity");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Authorization token obtained with POST /token
        String accept = accept_example; // String | 
        String contentType = contentType_example; // String | 
        Long idCase = 789; // Long | Case identification
        Long cdActivity = 789; // Long | Activity identification
        ProcessExecute body = ; // ProcessExecute | 
        try {
            ActvityStarted result = apiInstance.executeCurrentActivity(authorization, accept, contentType, idCase, cdActivity, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#executeCurrentActivity");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: application)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // Authorization token obtained with POST /token
String *accept = accept_example; // 
String *contentType = contentType_example; // 
Long *idCase = 789; // Case identification
Long *cdActivity = 789; // Activity identification
ProcessExecute *body = ; // 

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

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

// Configure OAuth2 access token for authorization: application
var application = defaultClient.authentications['application'];
application.accessToken = "YOUR ACCESS TOKEN"

var api = new DeyelApplication.DefaultApi()

var authorization = authorization_example; // {String} Authorization token obtained with POST /token

var accept = accept_example; // {String} 

var contentType = contentType_example; // {String} 

var idCase = 789; // {Long} Case identification

var cdActivity = 789; // {Long} Activity identification

var body = ; // {ProcessExecute} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.executeCurrentActivity(authorization, accept, contentType, idCase, cdActivity, body, 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()
        {
            
            // Configure OAuth2 access token for authorization: application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DefaultApi();
            var authorization = authorization_example;  // String | Authorization token obtained with POST /token
            var accept = accept_example;  // String | 
            var contentType = contentType_example;  // String | 
            var idCase = 789;  // Long | Case identification
            var cdActivity = 789;  // Long | Activity identification
            var body = new ProcessExecute(); // ProcessExecute | 

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

// Configure OAuth2 access token for authorization: application
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DefaultApi();
$authorization = authorization_example; // String | Authorization token obtained with POST /token
$accept = accept_example; // String | 
$contentType = contentType_example; // String | 
$idCase = 789; // Long | Case identification
$cdActivity = 789; // Long | Activity identification
$body = ; // ProcessExecute | 

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

# Configure OAuth2 access token for authorization: application
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $authorization = authorization_example; # String | Authorization token obtained with POST /token
my $accept = accept_example; # String | 
my $contentType = contentType_example; # String | 
my $idCase = 789; # Long | Case identification
my $cdActivity = 789; # Long | Activity identification
my $body = WWW::SwaggerClient::Object::ProcessExecute->new(); # ProcessExecute | 

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

# Configure OAuth2 access token for authorization: application
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = authorization_example # String | Authorization token obtained with POST /token
accept = accept_example # String | 
contentType = contentType_example # String | 
idCase = 789 # Long | Case identification
cdActivity = 789 # Long | Activity identification
body =  # ProcessExecute | 

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

Parameters

Path parameters
Name Description
idCase*
Long (int64)
Case identification
Required
cdActivity*
Long (int64)
Activity identification
Required
Header parameters
Name Description
Authorization*
String
Authorization token obtained with <b>POST /token</b>
Required
Accept*
String
Required
Content-Type*
String
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. Contact Salesforce Customer Support.


getForm

Retrieve form information.

Retrieve information from a specific form..


/forms/{idForm}

Usage and SDK Samples

curl -X GET "https://tuservicio.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.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: application
        OAuth application = (OAuth) defaultClient.getAuthentication("application");
        application.setAccessToken("YOUR ACCESS TOKEN");

        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Authorization token obtained with POST /token
        String accept = accept_example; // String | 
        String contentType = contentType_example; // String | 
        String idForm = idForm_example; // String | Form identification
        try {
            Form result = apiInstance.getForm(authorization, accept, contentType, idForm);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getForm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Authorization token obtained with POST /token
        String accept = accept_example; // String | 
        String contentType = contentType_example; // String | 
        String idForm = idForm_example; // String | Form identification
        try {
            Form result = apiInstance.getForm(authorization, accept, contentType, idForm);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getForm");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: application)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // Authorization token obtained with POST /token
String *accept = accept_example; // 
String *contentType = contentType_example; // 
String *idForm = idForm_example; // Form identification

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

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

// Configure OAuth2 access token for authorization: application
var application = defaultClient.authentications['application'];
application.accessToken = "YOUR ACCESS TOKEN"

var api = new DeyelApplication.DefaultApi()

var authorization = authorization_example; // {String} Authorization token obtained with POST /token

var accept = accept_example; // {String} 

var contentType = contentType_example; // {String} 

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(authorization, accept, contentType, 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()
        {
            
            // Configure OAuth2 access token for authorization: application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DefaultApi();
            var authorization = authorization_example;  // String | Authorization token obtained with POST /token
            var accept = accept_example;  // String | 
            var contentType = contentType_example;  // String | 
            var idForm = idForm_example;  // String | Form identification

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

// Configure OAuth2 access token for authorization: application
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DefaultApi();
$authorization = authorization_example; // String | Authorization token obtained with POST /token
$accept = accept_example; // String | 
$contentType = contentType_example; // String | 
$idForm = idForm_example; // String | Form identification

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

# Configure OAuth2 access token for authorization: application
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $authorization = authorization_example; # String | Authorization token obtained with POST /token
my $accept = accept_example; # String | 
my $contentType = contentType_example; # String | 
my $idForm = idForm_example; # String | Form identification

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

# Configure OAuth2 access token for authorization: application
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = authorization_example # String | Authorization token obtained with POST /token
accept = accept_example # String | 
contentType = contentType_example # String | 
idForm = idForm_example # String | Form identification

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

Parameters

Path parameters
Name Description
idForm*
String
Form identification
Required
Header parameters
Name Description
Authorization*
String
Authorization token obtained with <b>POST /token</b>
Required
Accept*
String
Required
Content-Type*
String
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. Contact Salesforce Customer Support.


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 "https://tuservicio.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.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: application
        OAuth application = (OAuth) defaultClient.getAuthentication("application");
        application.setAccessToken("YOUR ACCESS TOKEN");

        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Authorization token obtained with POST /token
        String accept = accept_example; // String | 
        String contentType = contentType_example; // String | 
        String idForm = idForm_example; // String | Form identification
        Integer idInstance = 56; // Integer | Instance identification
        try {
            InstanceValues result = apiInstance.getFormIntance(authorization, accept, contentType, idForm, idInstance);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getFormIntance");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Authorization token obtained with POST /token
        String accept = accept_example; // String | 
        String contentType = contentType_example; // String | 
        String idForm = idForm_example; // String | Form identification
        Integer idInstance = 56; // Integer | Instance identification
        try {
            InstanceValues result = apiInstance.getFormIntance(authorization, accept, contentType, idForm, idInstance);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getFormIntance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: application)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // Authorization token obtained with POST /token
String *accept = accept_example; // 
String *contentType = contentType_example; // 
String *idForm = idForm_example; // Form identification
Integer *idInstance = 56; // Instance identification

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

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

// Configure OAuth2 access token for authorization: application
var application = defaultClient.authentications['application'];
application.accessToken = "YOUR ACCESS TOKEN"

var api = new DeyelApplication.DefaultApi()

var authorization = authorization_example; // {String} Authorization token obtained with POST /token

var accept = accept_example; // {String} 

var contentType = contentType_example; // {String} 

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(authorization, accept, contentType, 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()
        {
            
            // Configure OAuth2 access token for authorization: application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DefaultApi();
            var authorization = authorization_example;  // String | Authorization token obtained with POST /token
            var accept = accept_example;  // String | 
            var contentType = contentType_example;  // String | 
            var idForm = idForm_example;  // String | Form identification
            var idInstance = 56;  // Integer | Instance identification

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

// Configure OAuth2 access token for authorization: application
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DefaultApi();
$authorization = authorization_example; // String | Authorization token obtained with POST /token
$accept = accept_example; // String | 
$contentType = contentType_example; // String | 
$idForm = idForm_example; // String | Form identification
$idInstance = 56; // Integer | Instance identification

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

# Configure OAuth2 access token for authorization: application
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $authorization = authorization_example; # String | Authorization token obtained with POST /token
my $accept = accept_example; # String | 
my $contentType = contentType_example; # String | 
my $idForm = idForm_example; # String | Form identification
my $idInstance = 56; # Integer | Instance identification

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

# Configure OAuth2 access token for authorization: application
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = authorization_example # String | Authorization token obtained with POST /token
accept = accept_example # String | 
contentType = contentType_example # String | 
idForm = idForm_example # String | Form identification
idInstance = 56 # Integer | Instance identification

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

Parameters

Path parameters
Name Description
idForm*
String
Form identification
Required
idInstance*
Integer
Instance identification
Required
Header parameters
Name Description
Authorization*
String
Authorization token obtained with <b>POST /token</b>
Required
Accept*
String
Required
Content-Type*
String
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. Contact Salesforce Customer Support.


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 "https://tuservicio.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.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: application
        OAuth application = (OAuth) defaultClient.getAuthentication("application");
        application.setAccessToken("YOUR ACCESS TOKEN");

        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Authorization token obtained with POST /token
        String accept = accept_example; // String | 
        String contentType = contentType_example; // String | 
        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(authorization, accept, contentType, idForm, search, pageNumber, perPage, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getFormIntances");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Authorization token obtained with POST /token
        String accept = accept_example; // String | 
        String contentType = contentType_example; // String | 
        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(authorization, accept, contentType, idForm, search, pageNumber, perPage, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getFormIntances");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: application)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // Authorization token obtained with POST /token
String *accept = accept_example; // 
String *contentType = contentType_example; // 
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)

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

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

// Configure OAuth2 access token for authorization: application
var application = defaultClient.authentications['application'];
application.accessToken = "YOUR ACCESS TOKEN"

var api = new DeyelApplication.DefaultApi()

var authorization = authorization_example; // {String} Authorization token obtained with POST /token

var accept = accept_example; // {String} 

var contentType = contentType_example; // {String} 

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(authorization, accept, contentType, 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()
        {
            
            // Configure OAuth2 access token for authorization: application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DefaultApi();
            var authorization = authorization_example;  // String | Authorization token obtained with POST /token
            var accept = accept_example;  // String | 
            var contentType = contentType_example;  // String | 
            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(authorization, accept, contentType, idForm, search, pageNumber, perPage, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getFormIntances: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: application
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DefaultApi();
$authorization = authorization_example; // String | Authorization token obtained with POST /token
$accept = accept_example; // String | 
$contentType = contentType_example; // String | 
$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($authorization, $accept, $contentType, $idForm, $search, $pageNumber, $perPage, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getFormIntances: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure OAuth2 access token for authorization: application
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $authorization = authorization_example; # String | Authorization token obtained with POST /token
my $accept = accept_example; # String | 
my $contentType = contentType_example; # String | 
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(authorization => $authorization, accept => $accept, contentType => $contentType, idForm => $idForm, search => $search, pageNumber => $pageNumber, perPage => $perPage, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->getFormIntances: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: application
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = authorization_example # String | Authorization token obtained with POST /token
accept = accept_example # String | 
contentType = contentType_example # String | 
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(authorization, accept, contentType, idForm, search=search, pageNumber=pageNumber, perPage=perPage, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->getFormIntances: %s\n" % e)

Parameters

Path parameters
Name Description
idForm*
String
Form identification
Required
Header parameters
Name Description
Authorization*
String
Authorization token obtained with <b>POST /token</b>
Required
Accept*
String
Required
Content-Type*
String
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. Contact Salesforce Customer Support.


getForms

Retrieve forms information..

Retrieves the information from the forms defined in DEYEL..


/forms

Usage and SDK Samples

curl -X GET "https://tuservicio.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.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: application
        OAuth application = (OAuth) defaultClient.getAuthentication("application");
        application.setAccessToken("YOUR ACCESS TOKEN");

        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Authorization token obtained with POST /token
        String accept = accept_example; // String | 
        String contentType = contentType_example; // String | 
        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(authorization, accept, contentType, search, pageNumber, perPage, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getForms");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Authorization token obtained with POST /token
        String accept = accept_example; // String | 
        String contentType = contentType_example; // String | 
        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(authorization, accept, contentType, search, pageNumber, perPage, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getForms");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: application)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // Authorization token obtained with POST /token
String *accept = accept_example; // 
String *contentType = contentType_example; // 
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)

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

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

// Configure OAuth2 access token for authorization: application
var application = defaultClient.authentications['application'];
application.accessToken = "YOUR ACCESS TOKEN"

var api = new DeyelApplication.DefaultApi()

var authorization = authorization_example; // {String} Authorization token obtained with POST /token

var accept = accept_example; // {String} 

var contentType = contentType_example; // {String} 

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(authorization, accept, contentType, 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()
        {
            
            // Configure OAuth2 access token for authorization: application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DefaultApi();
            var authorization = authorization_example;  // String | Authorization token obtained with POST /token
            var accept = accept_example;  // String | 
            var contentType = contentType_example;  // String | 
            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(authorization, accept, contentType, search, pageNumber, perPage, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getForms: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: application
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DefaultApi();
$authorization = authorization_example; // String | Authorization token obtained with POST /token
$accept = accept_example; // String | 
$contentType = contentType_example; // String | 
$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($authorization, $accept, $contentType, $search, $pageNumber, $perPage, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getForms: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure OAuth2 access token for authorization: application
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $authorization = authorization_example; # String | Authorization token obtained with POST /token
my $accept = accept_example; # String | 
my $contentType = contentType_example; # String | 
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(authorization => $authorization, accept => $accept, contentType => $contentType, search => $search, pageNumber => $pageNumber, perPage => $perPage, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->getForms: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: application
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = authorization_example # String | Authorization token obtained with POST /token
accept = accept_example # String | 
contentType = contentType_example # String | 
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(authorization, accept, contentType, search=search, pageNumber=pageNumber, perPage=perPage, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->getForms: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Authorization token obtained with <b>POST /token</b>
Required
Accept*
String
Required
Content-Type*
String
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. Contact Salesforce Customer Support.


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.


/token

Usage and SDK Samples

curl -X POST "https://tuservicio.deyel.com/v1.0/token"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: application
        OAuth application = (OAuth) defaultClient.getAuthentication("application");
        application.setAccessToken("YOUR ACCESS TOKEN");

        DefaultApi apiInstance = new DefaultApi();
        String accept = accept_example; // String | 
        String contentType = contentType_example; // String | 
        Credentials credentials = ; // Credentials | 
        try {
            apiInstance.getToken(accept, contentType, credentials);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getToken");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String accept = accept_example; // String | 
        String contentType = contentType_example; // String | 
        Credentials credentials = ; // Credentials | 
        try {
            apiInstance.getToken(accept, contentType, credentials);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: application)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *accept = accept_example; // 
String *contentType = contentType_example; // 
Credentials *credentials = ; // 

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

// Create and get authorization token.
[apiInstance getTokenWith:accept
    contentType:contentType
    credentials:credentials
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DeyelApplication = require('deyel_application');
var defaultClient = DeyelApplication.ApiClient.instance;

// Configure OAuth2 access token for authorization: application
var application = defaultClient.authentications['application'];
application.accessToken = "YOUR ACCESS TOKEN"

var api = new DeyelApplication.DefaultApi()

var accept = accept_example; // {String} 

var contentType = contentType_example; // {String} 

var credentials = ; // {Credentials} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getToken(accept, contentType, credentials, 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 OAuth2 access token for authorization: application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DefaultApi();
            var accept = accept_example;  // String | 
            var contentType = contentType_example;  // String | 
            var credentials = new Credentials(); // Credentials | 

            try
            {
                // Create and get authorization token.
                apiInstance.getToken(accept, contentType, credentials);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: application
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DefaultApi();
$accept = accept_example; // String | 
$contentType = contentType_example; // String | 
$credentials = ; // Credentials | 

try {
    $api_instance->getToken($accept, $contentType, $credentials);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure OAuth2 access token for authorization: application
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $accept = accept_example; # String | 
my $contentType = contentType_example; # String | 
my $credentials = WWW::SwaggerClient::Object::Credentials->new(); # Credentials | 

eval { 
    $api_instance->getToken(accept => $accept, contentType => $contentType, credentials => $credentials);
};
if ($@) {
    warn "Exception when calling DefaultApi->getToken: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: application
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
accept = accept_example # String | 
contentType = contentType_example # String | 
credentials =  # Credentials | 

try: 
    # Create and get authorization token.
    api_instance.get_token(accept, contentType, credentials)
except ApiException as e:
    print("Exception when calling DefaultApi->getToken: %s\n" % e)

Parameters

Header parameters
Name Description
Accept*
String
Required
Content-Type*
String
Required
Body parameters
Name Description
credentials *

Responses

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

Name Type Format Description
Date String
Content-Length Integer
Connection String
Set-Cookie String
Server String
Authorization String Authorization token

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. Contact Salesforce Customer Support.


startCase

Start a case.

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


/cases

Usage and SDK Samples

curl -X POST "https://tuservicio.deyel.com/v1.0/cases"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: application
        OAuth application = (OAuth) defaultClient.getAuthentication("application");
        application.setAccessToken("YOUR ACCESS TOKEN");

        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Authorization token obtained with POST /token
        String accept = accept_example; // String | 
        String contentType = contentType_example; // String | 
        StartCase caseData = ; // StartCase | Case information to be created
        try {
            CaseCreated result = apiInstance.startCase(authorization, accept, contentType, caseData);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#startCase");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Authorization token obtained with POST /token
        String accept = accept_example; // String | 
        String contentType = contentType_example; // String | 
        StartCase caseData = ; // StartCase | Case information to be created
        try {
            CaseCreated result = apiInstance.startCase(authorization, accept, contentType, caseData);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#startCase");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: application)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // Authorization token obtained with POST /token
String *accept = accept_example; // 
String *contentType = contentType_example; // 
StartCase *caseData = ; // Case information to be created

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

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

// Configure OAuth2 access token for authorization: application
var application = defaultClient.authentications['application'];
application.accessToken = "YOUR ACCESS TOKEN"

var api = new DeyelApplication.DefaultApi()

var authorization = authorization_example; // {String} Authorization token obtained with POST /token

var accept = accept_example; // {String} 

var contentType = contentType_example; // {String} 

var caseData = ; // {StartCase} Case information to be created


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startCase(authorization, accept, contentType, caseData, 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()
        {
            
            // Configure OAuth2 access token for authorization: application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DefaultApi();
            var authorization = authorization_example;  // String | Authorization token obtained with POST /token
            var accept = accept_example;  // String | 
            var contentType = contentType_example;  // String | 
            var caseData = new StartCase(); // StartCase | Case information to be created

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

// Configure OAuth2 access token for authorization: application
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DefaultApi();
$authorization = authorization_example; // String | Authorization token obtained with POST /token
$accept = accept_example; // String | 
$contentType = contentType_example; // String | 
$caseData = ; // StartCase | Case information to be created

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

# Configure OAuth2 access token for authorization: application
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $authorization = authorization_example; # String | Authorization token obtained with POST /token
my $accept = accept_example; # String | 
my $contentType = contentType_example; # String | 
my $caseData = WWW::SwaggerClient::Object::StartCase->new(); # StartCase | Case information to be created

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

# Configure OAuth2 access token for authorization: application
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = authorization_example # String | Authorization token obtained with POST /token
accept = accept_example # String | 
contentType = contentType_example # String | 
caseData =  # StartCase | Case information to be created

try: 
    # Start a case.
    api_response = api_instance.start_case(authorization, accept, contentType, caseData)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->startCase: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Authorization token obtained with <b>POST /token</b>
Required
Accept*
String
Required
Content-Type*
String
Required
Body parameters
Name Description
caseData *

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. Contact Salesforce Customer Support.


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 "https://tuservicio.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.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: application
        OAuth application = (OAuth) defaultClient.getAuthentication("application");
        application.setAccessToken("YOUR ACCESS TOKEN");

        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Authorization token obtained with POST /token
        String accept = accept_example; // String | 
        String contentType = contentType_example; // String | 
        String idForm = idForm_example; // String | Form identification
        Integer idInstance = 56; // Integer | Instance identification
        InstanceValues body = ; // InstanceValues | 
        try {
            apiInstance.updateFormIntance(authorization, accept, contentType, idForm, idInstance, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#updateFormIntance");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Authorization token obtained with POST /token
        String accept = accept_example; // String | 
        String contentType = contentType_example; // String | 
        String idForm = idForm_example; // String | Form identification
        Integer idInstance = 56; // Integer | Instance identification
        InstanceValues body = ; // InstanceValues | 
        try {
            apiInstance.updateFormIntance(authorization, accept, contentType, idForm, idInstance, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#updateFormIntance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: application)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // Authorization token obtained with POST /token
String *accept = accept_example; // 
String *contentType = contentType_example; // 
String *idForm = idForm_example; // Form identification
Integer *idInstance = 56; // Instance identification
InstanceValues *body = ; // 

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

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

// Configure OAuth2 access token for authorization: application
var application = defaultClient.authentications['application'];
application.accessToken = "YOUR ACCESS TOKEN"

var api = new DeyelApplication.DefaultApi()

var authorization = authorization_example; // {String} Authorization token obtained with POST /token

var accept = accept_example; // {String} 

var contentType = contentType_example; // {String} 

var idForm = idForm_example; // {String} Form identification

var idInstance = 56; // {Integer} Instance identification

var body = ; // {InstanceValues} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateFormIntance(authorization, accept, contentType, idForm, idInstance, body, 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()
        {
            
            // Configure OAuth2 access token for authorization: application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DefaultApi();
            var authorization = authorization_example;  // String | Authorization token obtained with POST /token
            var accept = accept_example;  // String | 
            var contentType = contentType_example;  // String | 
            var idForm = idForm_example;  // String | Form identification
            var idInstance = 56;  // Integer | Instance identification
            var body = new InstanceValues(); // InstanceValues | 

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

// Configure OAuth2 access token for authorization: application
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DefaultApi();
$authorization = authorization_example; // String | Authorization token obtained with POST /token
$accept = accept_example; // String | 
$contentType = contentType_example; // String | 
$idForm = idForm_example; // String | Form identification
$idInstance = 56; // Integer | Instance identification
$body = ; // InstanceValues | 

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

# Configure OAuth2 access token for authorization: application
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $authorization = authorization_example; # String | Authorization token obtained with POST /token
my $accept = accept_example; # String | 
my $contentType = contentType_example; # String | 
my $idForm = idForm_example; # String | Form identification
my $idInstance = 56; # Integer | Instance identification
my $body = WWW::SwaggerClient::Object::InstanceValues->new(); # InstanceValues | 

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

# Configure OAuth2 access token for authorization: application
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = authorization_example # String | Authorization token obtained with POST /token
accept = accept_example # String | 
contentType = contentType_example # String | 
idForm = idForm_example # String | Form identification
idInstance = 56 # Integer | Instance identification
body =  # InstanceValues | 

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

Parameters

Path parameters
Name Description
idForm*
String
Form identification
Required
idInstance*
Integer
Instance identification
Required
Header parameters
Name Description
Authorization*
String
Authorization token obtained with <b>POST /token</b>
Required
Accept*
String
Required
Content-Type*
String
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. Contact Salesforce Customer Support.


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 "https://tuservicio.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.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: application
        OAuth application = (OAuth) defaultClient.getAuthentication("application");
        application.setAccessToken("YOUR ACCESS TOKEN");

        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Authorization token obtained with POST /token
        String accept = accept_example; // String | 
        String contentType = contentType_example; // String | 
        String idForm = idForm_example; // String | Form identification
        Integer idInstance = 56; // Integer | Instance identification
        InstanceIn body = ; // InstanceIn | 
        try {
            apiInstance.updateValuesOfFormIntance(authorization, accept, contentType, idForm, idInstance, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#updateValuesOfFormIntance");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String authorization = authorization_example; // String | Authorization token obtained with POST /token
        String accept = accept_example; // String | 
        String contentType = contentType_example; // String | 
        String idForm = idForm_example; // String | Form identification
        Integer idInstance = 56; // Integer | Instance identification
        InstanceIn body = ; // InstanceIn | 
        try {
            apiInstance.updateValuesOfFormIntance(authorization, accept, contentType, idForm, idInstance, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#updateValuesOfFormIntance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: application)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *authorization = authorization_example; // Authorization token obtained with POST /token
String *accept = accept_example; // 
String *contentType = contentType_example; // 
String *idForm = idForm_example; // Form identification
Integer *idInstance = 56; // Instance identification
InstanceIn *body = ; // 

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

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

// Configure OAuth2 access token for authorization: application
var application = defaultClient.authentications['application'];
application.accessToken = "YOUR ACCESS TOKEN"

var api = new DeyelApplication.DefaultApi()

var authorization = authorization_example; // {String} Authorization token obtained with POST /token

var accept = accept_example; // {String} 

var contentType = contentType_example; // {String} 

var idForm = idForm_example; // {String} Form identification

var idInstance = 56; // {Integer} Instance identification

var body = ; // {InstanceIn} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateValuesOfFormIntance(authorization, accept, contentType, idForm, idInstance, body, 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()
        {
            
            // Configure OAuth2 access token for authorization: application
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DefaultApi();
            var authorization = authorization_example;  // String | Authorization token obtained with POST /token
            var accept = accept_example;  // String | 
            var contentType = contentType_example;  // String | 
            var idForm = idForm_example;  // String | Form identification
            var idInstance = 56;  // Integer | Instance identification
            var body = new InstanceIn(); // InstanceIn | 

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

// Configure OAuth2 access token for authorization: application
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\DefaultApi();
$authorization = authorization_example; // String | Authorization token obtained with POST /token
$accept = accept_example; // String | 
$contentType = contentType_example; // String | 
$idForm = idForm_example; // String | Form identification
$idInstance = 56; // Integer | Instance identification
$body = ; // InstanceIn | 

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

# Configure OAuth2 access token for authorization: application
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $authorization = authorization_example; # String | Authorization token obtained with POST /token
my $accept = accept_example; # String | 
my $contentType = contentType_example; # String | 
my $idForm = idForm_example; # String | Form identification
my $idInstance = 56; # Integer | Instance identification
my $body = WWW::SwaggerClient::Object::InstanceIn->new(); # InstanceIn | 

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

# Configure OAuth2 access token for authorization: application
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = authorization_example # String | Authorization token obtained with POST /token
accept = accept_example # String | 
contentType = contentType_example # String | 
idForm = idForm_example # String | Form identification
idInstance = 56 # Integer | Instance identification
body =  # InstanceIn | 

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

Parameters

Path parameters
Name Description
idForm*
String
Form identification
Required
idInstance*
Integer
Instance identification
Required
Header parameters
Name Description
Authorization*
String
Authorization token obtained with <b>POST /token</b>
Required
Accept*
String
Required
Content-Type*
String
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. Contact Salesforce Customer Support.