The scenario: The UCCX is integrating with a Ticketing system. The Ticketing system engineer provided me the REST commands they require to access their database. I am supposed to take their REST commands and make the appropriate format changes required by the UCCX REST step.
I have viewed probably over 100 posts on Anthony Holloways personal page regarding how to properly configure the UCCX REST step and due to my very limited knowledge of JSON and XML programming I have not been able to take their command and properly put it into the UCCX REST step.
Here is what the Ticketing system engineer provided me.
(This will return the Corporate ID and Login ID from TABLE)
http://IP Address:8008/api/arsys/v1/entry/TABLE?q='Corporate ID' LIKE "EDIPI_from_caller%"&fields=values(Full Name, Corporate ID, Internet E-mail, Remedy Login ID)
Here is my question: What is the format of the UCCX REST command that the UCCX needs to communicate to the Ticketing system database and retrieve items
The UCCX REST step has all the fields broken up and from what I can tell from the various posts I have viewed, the command formatting can be done in numerous ways. The developers guide is no help in that is states the obvious but does not provide any examples. I noticed from Anthony's posts he actually provides people examples and that is what I need. Thank in advance.
Let's see if we can help you out.
First, it looks like this is an HTTP GET request, which means there is no Body. You stated that your Ticketing System Engineer asked you to pass the credentials in the body, but that's not really a thing with HTTP GET requests. So, you will need to sort out how the authentication will work for this particular request first, before anything else can be done. One example might be HTTP Basic Authentication, in which case, the credentials go in the HTTP Headers, however, it's unencrypted and your URL shows HTTP as opposed to HTTPS, and so the credentials will be sent in clear text from UCCX to the Ticketing System. That may or may not concern someone, but I wanted to point it out. One way to know if it's HTTP Basic auth, is to construct the URL and paste it into your browser. If the browser prompts you for a username and password in a pop-up, then it's HTTP Basic Auth. If instead the browser just shows you an error page, like a 403, for example, then you likely have a different authentication mechanism in play.
Second, the URL you were given looks like an example, and you need to fill in some blanks, as well as replace some data with your own data. I would recommend constructing the full String before the Make REST Call Step, so that when you debug the script, you can see the final result of the URL prior to it being used by the Make REST Call Step. Can you ask them for a non-example, URL which you can use for testing/confirming?
Last, there are a lot of fields in the Make REST Call Step, but most of them do not need to be used. I'm going to guess you will end up using only 4 of them in the end.