web api | Community Creatio

Question

21:34 Oct 08, 2024

Hi All, I have setup a web service in Creatio that is working fine when I send parameters with data.

Sometimes I gonna call thie web service without all the parameters on the query, just one or more, it will depends on othe step before.

Is there a way to have a web service set up in Creatio with all parameters, but only make the call using the parameters that are not null?

3 comments

Daria Mudragel

17:46 Oct 09, 2024

Hello!

It depends on whether the parameters with NULL values are required or not.

You can try leaving out the NULL parameters and see how the service responds. If the call fails with an error, then you'll need to include those parameters.

Let us know if you need further assistance!

Ryan Farley

20:31 Oct 09, 2024

If the API you're calling is picky about the parameters being included without values, you can add the same service method twice, once with the params, and one without. Then just call one or the other based on the needs.

Paulo Victor Figorelli

20:48 Oct 10, 2024

Thanks for the replies, would be nice to have a way to disable a parameter, for situations like this.
For thie particular API I´m calling there are about 10 parameters available, and the way Creatio is doing, it´s sending all (query) parameters, even though its value is empty.
I´m trying to find a work around or a way to call this API sending only the required data.

Show all comments

Question

webservice

web api

Call Webservice element from Client side

Federico Buffa 🧐

19:56 Oct 14, 2022

Hi Team,

I have a webservice created with the designer in the web services setup integrations and I would like to call it from a client schema. There is any way to perform that?

1 comments

Dmytro Vovchenko

11:31 Oct 17, 2022

Hi Federico,

As far as I know, there is no direct way to call this type of web service from a client side, however, there is a small trick you can do. You can configure a business-process to run your service and on the client side, you can run this process.

Also, I will registrate your suggestion to our R&D team, thank you for giving us ideas to improve.

Show all comments

Question

Array parameter Web Service - Business Processs

Uriel Nusenbaum

22:53 Jul 11, 2022

Hi Community!!!

I used built in web service configuration to configure an integration with third party app.

The JSON that third party app receives looks like this:

{

"url": "https://test",

"events": ["a","b"]

}

The configuration for the events parameter into web service is as shown in the image below:

My issue is when I try to call this Web Service/Method from a Business Process. I cannot send the correct values for the events parameter. I tried several options for example: read a lookup values, create list or collection in a script task, etc. but I couldn't achive the goal.

The image below shows how the parameter is requested on the business process:

Below I show the trace with an example of the values I try to pass to the paramter:

"Parameter": "Events",

           "Value": {

               "Before execution": [

                   {

                       "Name": "invitee.created"

                   },

                   {

                       "Name": "invitee.canceled"

                   }

               ],

Any recomendation?

Regards.

3 comments

Cherednichenko Nikita

11:58 Jul 13, 2022

Hello,

You can send your values using a collection.

The values of collection parameters of a [ Call web service ] process element can be mapped to the nested parameters of another collection of a [ Read data ] or [ Call web service ] process element .Additionally, each item of the collection can be mapped to an individual subprocess instance in the [ Subprocess ] element.

You can find more detailed information on the academy website:

https://academy.creatio.com/docs/user/bpm_tools/process_elements_refere…

Uriel Nusenbaum

00:03 Jul 14, 2022

Cherednichenko Nikita,

Thank you! I tried it but the result is something like this:

[

                   {

                       "Name": "invitee.created"

                   },

                   {

                       "Name": "invitee.canceled"

                   }

               ],

The expected value is

[invitee.created","invitee.canceled"]

How can I achive this?

Regards.

Dmytro Vovchenko

12:16 Jul 19, 2022

Hello,

The code

[

                   {

                       "Name": "invitee.created"

                   },

                   {

                       "Name": "invitee.canceled"

                   }

],

Is seen like : [{"Name": "invitee.created"}, {"Name": "invitee.canceled"}].

But, in your case, I believe you can use the parameter value "Collection of values"

Show all comments

Question

Difficult to handle Collection type Response parameters

Julius

11:31 Sep 16, 2019

I have been struggling very much with handling collection type response parameters in web services.

When response parameters are or normal type they are very easy to handle in the business processes. Here we are able to handle them as parameters on the Call web service process element. And use these in the process right away.

When there is a Collection which is returned, this is very different. Now the Call web service element parameter is of type Collection of Objects with attributes.

It seems to me that this parameter-type is very difficult to handle in the business process. I can't seem to find documentation in the Academy about how to extract and loop through the contents of the Collection of Objects with attributes.

What I have found in the academy is this article about setting up the Web service.

https://academy.bpmonline.com/documents/administration/7-14/adding-resp…

What I need to learn is how to handle them in bpm'online business processes.

Is there something about this in the Academy?

Is writing source code the only option? It's difficult to debug.

6 comments

Norton Lingard

18:05 Sep 16, 2019

Dear Julius,

Unfortunately, it is impossible to handle parameters that have the “collection of object” type without using the source code.

Therefore, in this case we recommend using “ScriptTask” element for both calling the web-service and processing the results of call.

For more detailed assistance, please contact technical support.

Best regards,

Norton

Julius

09:20 Sep 17, 2019

Norton Lingard, Thank you. Is there anything like this in the academy? Because there is a special bpm'online syntax to go by in the source-code.

Norton Lingard

17:00 Sep 17, 2019

Dear Julius,

The service call in a "Script task” business process element can be implemented via native C#. Please find a lot of examples on how to do that in Google. For example, several links below:

https://stackoverflow.com/questions/9620278/how-do-i-make-calls-to-a-rest-api-using-c

https://code-maze.com/different-ways-consume-restful-api-csharp/

Please note that it is possible to use the native C# collections instead of working with the the special bpmonline collections.

Best regards,

Norton

Raz Guille Rosman

12:52 Jul 13, 2020

Hi Julius,

Did you manage to solve this?

I'm struggling with the same issue and didn't manage to get it to work.

Looking forward to having Your answer.

Raz

Raz Guille Rosman

12:55 Jul 13, 2020

Norton Lingard,

Hi Norton,

Is there another example on how to do it in the script task?

I tried implementing it based on the links you posted and I'm getting many error messages when posting the code.

Thanks,

Raz

Norton Lingard

16:46 Jul 13, 2020

Dear Raz,

Please find another example in the article by the link below:

https://stackoverflow.com/questions/3900371/how-can-i-call-a-webservice-from-c-sharp-with-http-post

If you still can’t resolve the issue please provide us with a source code that you wrote and errors that you got.

Best regards,

Norton

Show all comments

Question

Mock dummy data in virtual object

M Shrikanth

13:27 Jul 20, 2019

Hi

We have a use case whereby the data we need to show in a detail needs to be fetched from a 3rd party API. We intend to do the following steps for this -

1. Create a virtual object (Transient data. Not to be persisted in the database)

2. Call the the 3rd party API and populate the virtual object with the returned data.

3. Bind the virtual object to the Detail.

The API is still under construction and we would like to mock / populate / hard code dummy data in the virtual object so that we can proceed with developing the detail. Let me know if there is a way to do this.

Thanks

Shrikanth

1 comments

Best reply

Anastasia Botezat

15:18 Jul 22, 2019

Dear Shrikanth,

Please see the following article on how to implement virtual detail on page with calling API to populate data:

https://community.bpmonline.com/articles/add-virtual-detail-page

Hope you find it helpful,

Anastasia

Anastasia Botezat

15:18 Jul 22, 2019

Dear Shrikanth,

Please see the following article on how to implement virtual detail on page with calling API to populate data:

https://community.bpmonline.com/articles/add-virtual-detail-page

Hope you find it helpful,

Anastasia

Show all comments

Question

Web API

aaykay

03:31 Jul 01, 2019

Hi,

Can someone please direct me to any documentation around how to add data to bpmonline when receiving the data through an API?

Does the JSON.NET work for bpmonline or do I have to use JavaScriptSerializer class?

1 comments

Abinaya

09:29 Jul 01, 2019

Hi aaykay

Please refer to the below link:

https://academy.bpmonline.com/documents/technic-sdk/7-13/integration-bpmonline-and-public-api

The above link will have all information related to API integration and the management of data recieved through them.

In the below link, you will specifically find how to do CRUD operations in BPMOnline objects like Contacts etc.

https://academy.bpmonline.com/documents/technic-sdk/7-13/working-bpmonline-objects-over-odata-protocol-wcf-client

Thanks

Abinaya

Show all comments

Question

aaykay

07:51 Jun 25, 2019

Hi,

If I have to build a web service from bpmonline through an api which requires the method signature to be generated by taking the query string, and creating a HMAC-SHA256 signature using your API key as the secret key.

Is there a way to do that?

There is available a sample c# code, if that helps.

Generating the method signature

    <span>private</span> <span>static</span> <span>string</span> <span>GetSignature</span><span>(</span><span>string</span> <span>args</span><span>,</span> <span>string</span> <span>privatekey</span><span>)</span> 
    <span>{</span> 
        <span>var</span> <span>encoding</span> <span>=</span> <span>new</span> <span>System</span><span>.</span><span>Text</span><span>.</span><span>UTF8Encoding</span><span>();</span> 
        <span>byte</span><span>[]</span> <span>key</span> <span>=</span> <span>encoding</span><span>.</span><span>GetBytes</span><span>(</span><span>privatekey</span><span>);</span> 
        <span>var</span> <span>myhmacsha256</span> <span>=</span> <span>new</span> <span>HMACSHA256</span><span>(</span><span>key</span><span>);</span> 
        <span>byte</span><span>[]</span> <span>hashValue</span> <span>=</span> <span>myhmacsha256</span><span>.</span><span>ComputeHash</span><span>(</span><span>encoding</span><span>.</span><span>GetBytes</span><span>(</span><span>args</span><span>));</span> 
        <span>string</span> <span>hmac64</span> <span>=</span> <span>Convert</span><span>.</span><span>ToBase64String</span><span>(</span><span>hashValue</span><span>);</span> 
        <span>myhmacsha256</span><span>.</span><span>Clear</span><span>();</span> 
        <span>return</span> <span>hmac64</span><span>;</span> 
    <span>}</span>

<span>I am trying to integrate with </span>https://apidocs.unleashedsoftware.com/AuthenticationHelp

1 comments

Eugene Podkovka

21:00 Jun 25, 2019

It's hard to understand what is "from bpmonline through an api". Will the service be in bpm'online or somewhere else? Should bpm'online call an external web service?

Anyway. Please find more information about calling web services in the article by the link below.

https://academy.bpmonline.com/documents/technic-sdk/7-13/executing-odata-queries-using-fiddler

Show all comments

Question

web api

7.12_()

sales

error when authenticating with api

bellli

15:56 Feb 23, 2019

Hi!

Guided by https://academy.bpmonline.com/documents/technic-sdk/7-11/authservicesvc…

I am trying to authenticate using fiddler as client, but I get an error, please tell me what am I doing wrong.

user have access to OData.

what i receive:

HTTP/1.1 401 Unauthorized

Cache-Control: private

Content-Type: application/json; charset=utf-8

Server: Microsoft-IIS/8.5

jsonerror: true

X-Powered-By: ASP.NET

X-Frame-Options: SAMEORIGIN

X-Content-Type-Options: nosniff

Date: Sat, 23 Feb 2019 08:02:33 GMT

Content-Length: 91

{"Message":"There was an error processing the request.","StackTrace":"","ExceptionType":""}

1 comments

Anastasia Botezat

14:25 Feb 25, 2019

Dear Bellil,

Please see the article below on how to proceed with the authentication with bpm'online using OData protocol and Fiddler application

https://academy.bpmonline.com/documents/technic-sdk/7-13/executing-odat…

Also, I would like to share the approach I use: I open the Fiddler --> start tracing all requests --> open login page and enter the credentials --> hit login and looking for this request in Fiddler --> drag the caught request into Fiddler Composer window. There I can see all the headers, and body sent to the system. This helps to understand what is needed, run same request with modified data (if needed for any testing).

Hope you will find it helpful,

Anastasia

Show all comments

Question

web service

web api

webservice restful external integration

call web service

7.13_()

sales_team

problem in processing the response of a Web Service in JSON format ... how can it be corrected?

AAlonso.29

16:19 Jan 31, 2019

When trying to call a web service from the BPM'Online platform, the process throws the following error:

we assume that the error is due to the immense size of the JSON that we try to read from the external web service, so that the response would exceed the processing capacity limits of the webservice module of the bpm'online tool.

Our consulate is, if there is a way to increase the data processing limit of the bpm'online web service module in terms of reading the JSON delivered by the external web service.

We estimate that approximately 6 GB of RAM is needed to process the desired volume of data.

2 comments

Eugene Podkovka

21:08 Feb 12, 2019

It doesn't seem to be a memory issue. Bpm'online provides up to around 8 GB RAM in critical moments and 4 GB by default. Anyway, If the application consumes more than around 8 GB RAM, IIS restarts it automatically. If you need more resources, please contact your account manager and the limits will be increased.

It seems like the issue is related to a wrong JSON format. However, since the JSON is huge you'll not be able to debug it. In this case I recommend to create your own web service according to the article by the link below.

https://academy.bpmonline.com/documents/technic-sdk/7-13/how-create-cus…

This way in case of the exception message you'll be able to create your own logging or debug the service on a local copy of the application.

Please be aware of the fact that during the integration process that consumes almost all available RAM users might face performance issues.

AAlonso.29

21:27 Feb 12, 2019

Thank you very much for the reply; it was indeed an error of the JSON that was being called, since it contained Null fields that did not correspond.

Show all comments

Question

Call API Rest from c# script

Ezequiel Rául Gómez

22:20 Nov 20, 2018

Hi community!

How are you?

Any example for call a API Rest from c# script in a businessProcess?

I have a list of processes to call from a detail, one of them must call an API and process the response but I can not use the "Call Web service" element because the request needs a json structure with many nests and I can not complete it in any other way that is not a script, any suggestions?

King Regards,

Ezequiel

1 comments

Anastasia Botezat

16:09 Nov 21, 2018

Dear Ezequiel,

Configuring the method for "Call web service" business process parameter please use quick setup:

In this case, for example, if you provide the JSON with a nested element or even with a nested array:

The system will automatically configure correct JSON paths:

Afterward, choosing this method in "Call web service" business process parameter, you will be able to fill in any nested parameter:

The only thing that may be uncomfortable for now is that for the nested array you can fill only the first element.

In case you need to fill a bunch of the array elements please try to use any synchronous C# methods in scrip-task instead, for example, the first answer in this topic may work for you: https://stackoverflow.com/questions/9145667/how-to-post-json-to-a-server-using-c

Regards,

Anastasia

Show all comments

Subscribe to web api