I'm creating an API connector using the SOAR function. I've done some testing and it works perfectly, but how can I send a variable within the field?

The documentation only mentions using "playbook.inputs.xxxxxx", but the query can't possibly be an input!

What alternatives do you think are possible?

Hi Juan,

If I understand correctly, you wish to mix constant text with variable text so that the request string matches what the endpoints expects.

You are going to have to manage this with a script. 

To do this, I have created a subplaybook that take one parameter as input for the artifact.value.
I define the output for the subplaybook with the json schema so that the data navigator knows the subplaybook will return a string as part of the result.

{  "type": "object",  "properties": {    "request": {      "type": "string"    }  },  "required": [    "request"  ]}

I setup the subplaybook with just one start and one end point. In the end point, I define  the result in that way:

playbook.results = {"request": "param1=hard-value1&param2=value2&artifact=" + playbook.inputs.artifact}

Add the subplaybook node just before your connector add a result name and save the playbook. For the subplaybook input select the field you want to use with the data navigator.
For the request parameter select the subplyabook request attribute from result object.

I'm creating an API connector using the SOAR function. I've done some testing and it works perfectly, but how can I send a variable within the field?

The documentation only mentions using "playbook.inputs.xxxxxx", but the query can't possibly be an input!

What alternatives do you think are possible?

Hi,
I've just stumbled upon the very same issue today.
I find it quite odd that IBM has provided us with ability to define Form and Raw input for connector function's request body, but we can't do the same for Request Parameters.

And what is even more frustrating - I did properly format my input via local script and stored it within playbook.properties object via playbook.addProperty function before passing it to connector function. And yet, it was to no avail - request parameter schema wouldn't show properties object under playbook.

All of this fiddling with sub-playbooks just to do this simple operation seems like IBM has done a poor job with connector function usability.

I don't even know why I wrote it hear - just my cry of the soul, I guess 😅

Hi Juan,

If I understand correctly, you wish to mix constant text with variable text so that the request string matches what the endpoints expects.

You are going to have to manage this with a script. 

To do this, I have created a subplaybook that take one parameter as input for the artifact.value.
I define the output for the subplaybook with the json schema so that the data navigator knows the subplaybook will return a string as part of the result.

{  "type": "object",  "properties": {    "request": {      "type": "string"    }  },  "required": [    "request"  ]}

I setup the subplaybook with just one start and one end point. In the end point, I define  the result in that way:

playbook.results = {"request": "param1=hard-value1&param2=value2&artifact=" + playbook.inputs.artifact}

Add the subplaybook node just before your connector add a result name and save the playbook. For the subplaybook input select the field you want to use with the data navigator.
For the request parameter select the subplyabook request attribute from result object.

I'm creating an API connector using the SOAR function. I've done some testing and it works perfectly, but how can I send a variable within the field?

The documentation only mentions using "playbook.inputs.xxxxxx", but the query can't possibly be an input!

What alternatives do you think are possible?

Hi,
I've just stumbled upon the very same issue today.
I find it quite odd that IBM has provided us with ability to define Form and Raw input for connector function's request body, but we can't do the same for Request Parameters.

And what is even more frustrating - I did properly format my input via local script and stored it within playbook.properties object via playbook.addProperty function before passing it to connector function. And yet, it was to no avail - request parameter schema wouldn't show properties object under playbook.

All of this fiddling with sub-playbooks just to do this simple operation seems like IBM has done a poor job with connector function usability.

I don't even know why I wrote it hear - just my cry of the soul, I guess 😅

Hi Juan,

If I understand correctly, you wish to mix constant text with variable text so that the request string matches what the endpoints expects.

You are going to have to manage this with a script. 

To do this, I have created a subplaybook that take one parameter as input for the artifact.value.
I define the output for the subplaybook with the json schema so that the data navigator knows the subplaybook will return a string as part of the result.

{  "type": "object",  "properties": {    "request": {      "type": "string"    }  },  "required": [    "request"  ]}

I setup the subplaybook with just one start and one end point. In the end point, I define  the result in that way:

playbook.results = {"request": "param1=hard-value1&param2=value2&artifact=" + playbook.inputs.artifact}

Add the subplaybook node just before your connector add a result name and save the playbook. For the subplaybook input select the field you want to use with the data navigator.
For the request parameter select the subplyabook request attribute from result object.

I'm creating an API connector using the SOAR function. I've done some testing and it works perfectly, but how can I send a variable within the field?

The documentation only mentions using "playbook.inputs.xxxxxx", but the query can't possibly be an input!

What alternatives do you think are possible?