webservice_adaptor
Differences
This shows you the differences between two versions of the page.
|
webservice_adaptor [2024/12/11 15:15] montse [Authentication Types] |
webservice_adaptor [2024/12/11 15:31] (current) montse |
||
|---|---|---|---|
| Line 24: | Line 24: | ||
| * **deleteRest(resource, headers)** | * **deleteRest(resource, headers)** | ||
| - | * Description: It allows the configuration of an HTTP request of type Delete. | + | * Description: it allows the configuration of an HTTP request of type Delete. |
| - | * Resource: Indicates the resource within the EndPoint on which the request will be made. | + | * Resource: indicates the resource within the EndPoint on which the request will be made. |
| - | * Headers: Indicates the headers that must be added to the request. | + | * Headers: indicates the headers that must be added to the request. |
| - | * Charset: To choose what charset the user wants. | + | * Charset: to choose what charset the user wants. |
| - | * Body: Indicates que content of the parameter. | + | * Body: indicates que content of the parameter. |
| * **getALLJSONElementValueByTagname(ResponseName, JsonTagName)** | * **getALLJSONElementValueByTagname(ResponseName, JsonTagName)** | ||
| - | * Description: If the content of the response to a request is JSON, this function allows to retrieve all the values of the element linked to the tagName as an array of values represented with a tastRowValues object. The result is presented with the values separated by the character |, in the field Message / Result / Value. | + | * Description: if the content of the response to a request is JSON, this function allows to retrieve all the values of the element linked to the tagName as an array of values represented with a tastRowValues object. The result is presented with the values separated by the character |, in the field Message / Result / Value. |
| - | * ResponseName: Indicate the name which the Http Response was generated. | + | * ResponseName: indicate the name which the Http Response was generated. |
| * JSonTagName: TagName expression used to identify the element. | * JSonTagName: TagName expression used to identify the element. | ||
| * **getALLXMLElementValueByTagName(StepResponse, ElementTag)** | * **getALLXMLElementValueByTagName(StepResponse, ElementTag)** | ||
| - | * Description: If the content of the response to a request is XML, this function allows to retrieve all the values of the element linked to the tagName as an array of values represented with a tastRowValues object. Instead of returning only one element (the first), this PF returns a list of all elements. | + | * Description: if the content of the response to a request is XML, this function allows to retrieve all the values of the element linked to the tagName as an array of values represented with a tastRowValues object. Instead of returning only one element (the first), this PF returns a list of all elements. |
| - | * ResponseName: Indicate the name which the Http Response was generated. | + | * ResponseName: indicate the name which the Http Response was generated. |
| * ElementTag: XML´s tag used to identify the element. | * ElementTag: XML´s tag used to identify the element. | ||
| * **getCookieValue(StepResponse, Cookie)** | * **getCookieValue(StepResponse, Cookie)** | ||
| - | * Description: Retrieve the value of the indicated cookie. | + | * Description: retrieve the value of the indicated cookie. |
| - | * ResponseName: Indicate the name which the Http Response was generated. | + | * ResponseName: indicate the name which the Http Response was generated. |
| - | * Cookie: Indicates Cookie´s name to retrieve. | + | * Cookie: indicates Cookie´s name to retrieve. |
| - | * **getElementsCountByJsonPath(JsonPath, ResponseName)**: Returns the number of elements that have the same JsonPath. | + | * **getElementsCountByJsonPath(JsonPath, ResponseName)**: returns the number of elements that have the same JsonPath. |
| - | * JsonPath: The JsonPath to search for. | + | * JsonPath: the JsonPath to search for. |
| - | * ResponseName: The name under which the HTTP response was generated. | + | * ResponseName: the name under which the HTTP response was generated. |
| | | ||
| - | * **getElementsCountByTagName(tagName, ResponseName)**: Returns the number of elements that have the same tag name. | + | * **getElementsCountByTagName(tagName, ResponseName)**: returns the number of elements that have the same tag name. |
| - | * tagName: The tag name to search for. | + | * tagName: the tag name to search for. |
| - | * ResponseName: The name under which the HTTP response was generated. | + | * ResponseName: the name under which the HTTP response was generated. |
| - | * **getElementsValueByJsonPath(JsonPath, ResponseName)**: Returns all elements that have the same JsonPath. | + | * **getElementsValueByJsonPath(JsonPath, ResponseName)**: returns all elements that have the same JsonPath. |
| - | * JsonPath: The JsonPath to search. | + | * JsonPath: the JsonPath to search. |
| - | * ResponseName: The name under which the HTTP response was generated. | + | * ResponseName: the name under which the HTTP response was generated. |
| * **getHeaderValue(StepResponse, Header)** | * **getHeaderValue(StepResponse, Header)** | ||
| - | * Description: It allows to obtain the value of a received header in an HTTP response. | + | * Description: it allows to obtain the value of a received header in an HTTP response. |
| - | * ResponseName: Indicate the name which the Http Response was generated. | + | * ResponseName: indicate the name which the Http Response was generated. |
| - | * Header: The name of the header from which you want to extract the value. | + | * Header: the name of the header from which you want to extract the value. |
| * **getHTMLElementValueByXpath()** | * **getHTMLElementValueByXpath()** | ||
| - | * Description: If the content of the response to a request is HTML, this function allows to retrieve a value of an element, using to identify the element an XPath expression. | + | * Description: if the content of the response to a request is HTML, this function allows to retrieve a value of an element, using to identify the element an XPath expression. |
| - | * ResponseName: Indicate the name which the Http Response was generated. | + | * ResponseName: indicate the name which the Http Response was generated. |
| * XPathExp: XPath expression used to identify the element. | * XPathExp: XPath expression used to identify the element. | ||
| * **getJSONElementValueByJsonPath(StepResponse, JSonPathExp)** | * **getJSONElementValueByJsonPath(StepResponse, JSonPathExp)** | ||
| - | * Description: If the content of the response to a request is JSON, this function allows to retrieve a value of an element used to identify the element the JsonPath. If there are more than one element, returns the first. | + | * Description: if the content of the response to a request is JSON, this function allows to retrieve a value of an element used to identify the element the JsonPath. If there are more than one element, returns the first. |
| - | * ResponseName: Indicate the name which the Http Response was generated. | + | * ResponseName: indicate the name which the Http Response was generated. |
| * JSonPathExp: JSonPath expression used to identify the element. | * JSonPathExp: JSonPath expression used to identify the element. | ||
| * **getJSONElementValueByTagName(StepResponse, TagnameExp)** | * **getJSONElementValueByTagName(StepResponse, TagnameExp)** | ||
| - | * Description: If the content of the response to a request is JSON, this function allows to retrieve a value of an element used to identify the element the TagName. If there are more than one element, returns the first. The result is presented with the values separated by the character |, in the field Message / Result / Value. | + | * Description: if the content of the response to a request is JSON, this function allows to retrieve a value of an element used to identify the element the TagName. If there are more than one element, returns the first. The result is presented with the values separated by the character |, in the field Message / Result / Value. |
| - | * ResponseName: Indicate the name which the Http Response was generated. | + | * ResponseName: indicate the name which the Http Response was generated. |
| * JSonTagName: Tagname expression used to identify the element. | * JSonTagName: Tagname expression used to identify the element. | ||
| Line 80: | Line 80: | ||
| * **getResponseStatus(StepResponse)** | * **getResponseStatus(StepResponse)** | ||
| - | * Description: Allows to retrieve response´s Http status code. | + | * Description: allows to retrieve response´s Http status code. |
| - | * ResponseName: Indicate the name which the Http Response was generated. | + | * ResponseName: indicate the name which the Http Response was generated. |
| - | * **getResponseTime**: Returns the time taken in milliseconds to receive the response to a request. To identify the response it receives a parameter with the name of the HttpResponse variable from which we want to obtain the information. | + | * **getResponseTime**: returns the time taken in milliseconds to receive the response to a request. To identify the response it receives a parameter with the name of the HttpResponse variable from which we want to obtain the information. |
| * **getRest(resource, headers, parameters)** | * **getRest(resource, headers, parameters)** | ||
| - | * Description: It allows to configure an HTTP request of type Get. | + | * Description: it allows to configure an HTTP request of type Get. |
| - | * Resource: Indicates the resource within the EndPoint on which the request will be made. | + | * Resource: indicates the resource within the EndPoint on which the request will be made. |
| - | * Headers: Indicates the headers that must be added to the request. | + | * Headers: indicates the headers that must be added to the request. |
| - | * Parameters: Indicates the parameters that must be added to the URL of the request. | + | * Parameters: indicates the parameters that must be added to the URL of the request. |
| - | * Charset: To choose what charset the user wants. | + | * Charset: to choose what charset the user wants. |
| * **getXMLElementValueByTagName(StepResponse, ElementTag)** | * **getXMLElementValueByTagName(StepResponse, ElementTag)** | ||
| - | * Description: If the content of the response to a request is XML, this function allows to retrieve a value of an element using the tag to identify it. If there are more than one element, returns the first. | + | * Description: if the content of the response to a request is XML, this function allows to retrieve a value of an element using the tag to identify it. If there are more than one element, returns the first. |
| - | * ResponseName: Indicate the name which the Http Response was generated. | + | * ResponseName: indicate the name which the Http Response was generated. |
| * ElementTag: XML´s tag used to identify the element. | * ElementTag: XML´s tag used to identify the element. | ||
| * **getXMLElementValueByXPath(StepResponse, XPathExp)** | * **getXMLElementValueByXPath(StepResponse, XPathExp)** | ||
| - | * Description: If the content of the response to a request is XML, this function allows to retrieve a value of an element, using to identify the element an XPath expression. Also, it allows to search values in responses with XHTML content type. | + | * Description: if the content of the response to a request is XML, this function allows to retrieve a value of an element, using to identify the element an XPath expression. Also, it allows to search values in responses with XHTML content type. |
| - | * ResponseName: Indicate the name which the Http Response was generated. | + | * ResponseName: indicate the name which the Http Response was generated. |
| * XPathExp: XPath expression used to identify the element. | * XPathExp: XPath expression used to identify the element. | ||
| * **patchRest(resource, headers, content-type, body)** | * **patchRest(resource, headers, content-type, body)** | ||
| - | * Description: It allows you to configure an HTTP request of type Patch. | + | * Description: it allows you to configure an HTTP request of type Patch. |
| - | * Resource: Indicates the resource within the EndPoint on which the request will be made. | + | * Resource: indicates the resource within the EndPoint on which the request will be made. |
| - | * Headers: Indicates the headers that must be added to the request. | + | * Headers: indicates the headers that must be added to the request. |
| * Content-type: HTTP standard header that indicates the type of content that is added to the body of the request. | * Content-type: HTTP standard header that indicates the type of content that is added to the body of the request. | ||
| - | * Body: Content of the Http request. | + | * Body: content of the Http request. |
| * **postRest(resource, headers, content-type, body)** | * **postRest(resource, headers, content-type, body)** | ||
| - | * Description: It allows you to configure an HTTP request of type Post. | + | * Description: it allows you to configure an HTTP request of type Post. |
| - | * Resource: Indicates the resource within the EndPoint on which the request will be made. | + | * Resource: indicates the resource within the EndPoint on which the request will be made. |
| - | * Headers: Indicates the headers that must be added to the request. | + | * Headers: indicates the headers that must be added to the request. |
| * Content-type: HTTP standard header that indicates the type of content that is added to the body of the request. | * Content-type: HTTP standard header that indicates the type of content that is added to the body of the request. | ||
| - | * Body: Content of the Http request. | + | * Body: content of the Http request. |
| * **putRest(resource, headers, content-type, body)** | * **putRest(resource, headers, content-type, body)** | ||
| - | * Description: Allows you to configure an HTTP request of type Put. | + | * Description: allows you to configure an HTTP request of type Put. |
| - | * Resource: Indicates the resource within the EndPoint on which the request will be made. | + | * Resource: indicates the resource within the EndPoint on which the request will be made. |
| - | * Headers: Indicates the headers that must be added to the request. | + | * Headers: indicates the headers that must be added to the request. |
| * Content-type: HTTP standard header that indicates the type of content that is added to the body of the request. | * Content-type: HTTP standard header that indicates the type of content that is added to the body of the request. | ||
| - | * Body: Content of the Http request. | + | * Body: content of the Http request. |
| * **responseBodyContainsText(responseName, searchValue)** | * **responseBodyContainsText(responseName, searchValue)** | ||
| - | * Description: Search in the body field of the response (stepResponse), if there is any match with the string of parameter searchValue. True return if affirmative. | + | * Description: search in the body field of the response (stepResponse), if there is any match with the string of parameter searchValue. True return if affirmative. |
| - | * ResponseName: Indicate the name which the Http Response was generated. | + | * ResponseName: indicate the name which the Http Response was generated. |
| - | * SearchValue: Text to search inside body of response. | + | * SearchValue: text to search inside body of response. |
| * **setBasicAuthentication(user, password)** | * **setBasicAuthentication(user, password)** | ||
| - | * Description: It allows to configure the authentication scheme of the requests that are sent to the EndPoint as BasicAuthentication. It overwrites the security setting done in the adapter setup. | + | * Description: it allows to configure the authentication scheme of the requests that are sent to the EndPoint as BasicAuthentication. It overwrites the security setting done in the adapter setup. |
| - | * User: User code used as credential. | + | * User: user code used as credential. |
| - | * Password: Password to present as credential. | + | * Password: password to present as credential. |
| * **setBearerTokenAuthentication(token)** | * **setBearerTokenAuthentication(token)** | ||
| - | * Description: It allows configuring the authentication scheme of the requests that are send to the endpoint as Bearer Token Authentication Scheme. It overwrites the security setting done in the adapter setup. | + | * Description: it allows configuring the authentication scheme of the requests that are send to the endpoint as Bearer Token Authentication Scheme. It overwrites the security setting done in the adapter setup. |
| - | * Token: Token´s value that will be presented as credential. | + | * Token: token´s value that will be presented as credential. |
| * **setDigestAuthentication(user, password, realm, nonce, algorithm, Qoq, NonceCount, ClientNonce, Opaque)** | * **setDigestAuthentication(user, password, realm, nonce, algorithm, Qoq, NonceCount, ClientNonce, Opaque)** | ||
| - | * Description: It allows configuring the authentication schema of the requests that are send to the endpoint as Digest Authentication Schema. It overwrites the security setting done in the adapter setup. | + | * Description: it allows configuring the authentication schema of the requests that are send to the endpoint as Digest Authentication Schema. It overwrites the security setting done in the adapter setup. |
| - | * User: Username used as credential. | + | * User: username used as credential. |
| - | * Password: Password to present as credential. | + | * Password: password to present as credential. |
| - | * Realm: Security domain on which security validation must be performed. It is optional, if it is not known, the adapter will try to perform the validation with the data obtained from the response to the challenge. | + | * Realm: security domain on which security validation must be performed. It is optional, if it is not known, the adapter will try to perform the validation with the data obtained from the response to the challenge. |
| - | * Nonce: Nonce returned by the server. It is optional, if it is not known, the adapter will try to perform the validation with the data obtained from the response to the challenge. | + | * Nonce: nonce returned by the server. It is optional, if it is not known, the adapter will try to perform the validation with the data obtained from the response to the challenge. |
| - | * Algorithm: Algorithm used for encryption. It is optional, if it is not known, the adapter will try to perform the validation with the data obtained from the response to the challenge. | + | * Algorithm: algorithm used for encryption. It is optional, if it is not known, the adapter will try to perform the validation with the data obtained from the response to the challenge. |
| - | * Qoq: Quality of the protection code. It is optional, if it is not known, the adapter will try to perform the validation with the data obtained from the response to the challenge. | + | * Qoq: quality of the protection code. It is optional, if it is not known, the adapter will try to perform the validation with the data obtained from the response to the challenge. |
| - | * NonceCount: NonceCount associated with the request. It is optional, if it is not known, the adapter will try to perform the validation with the data obtained from the response to the challenge. | + | * NonceCount: nonceCount associated with the request. It is optional, if it is not known, the adapter will try to perform the validation with the data obtained from the response to the challenge. |
| - | * ClientNonce: Nonce generated by the client. It is optional, if it is not known, the adapter will try to perform the validation with the data obtained from the response to the challenge. | + | * ClientNonce: nonce generated by the client. It is optional, if it is not known, the adapter will try to perform the validation with the data obtained from the response to the challenge. |
| - | * Opaque: Opaque returned by the server. It is optional, if it is not known, the adapter will try to perform the validation with the data obtain | + | * Opaque: opaque returned by the server. It is optional, if it is not known, the adapter will try to perform the validation with the data obtain |
| * **setNoneAuthentication()** | * **setNoneAuthentication()** | ||
| - | * Description: It allows to configure the authentication method of the requests that are sent to the EndPoint as requests without authentication scheme. It overwrites the security setting done in the adapter setup.\\ | + | * Description: it allows to configure the authentication method of the requests that are sent to the EndPoint as requests without authentication scheme. It overwrites the security setting done in the adapter setup.\\ |
| Line 501: | Line 501: | ||
| In case the answer is correctly parsed, it will be presented in a text box, where you can click on the elements of the answer for which the JSONPath / XPath can be calculated. | In case the answer is correctly parsed, it will be presented in a text box, where you can click on the elements of the answer for which the JSONPath / XPath can be calculated. | ||
| - | {{:Asistente_mapeo_REST_eng_18.png?nolink&3000|}} | + | {{ :Asistente_mapeo_REST_eng_18.png?nolink&1000| }} |
| The elements on which your JSONPath / Xpath can be obtained, will present a hand when the cursor passes over them.\\ | The elements on which your JSONPath / Xpath can be obtained, will present a hand when the cursor passes over them.\\ | ||
| By clicking on them, the JSONPath / XPath will be presented on the text box immediately below: | By clicking on them, the JSONPath / XPath will be presented on the text box immediately below: | ||
| - | {{:Asistente_mapeo_REST_eng_19.png?nolink&3000|}} | + | {{ :Asistente_mapeo_REST_eng_19.png?nolink&1000|}} |
| - | The calculated JSONPath / XPath value can be copied to the clipboard by clicking on the button {{:Asistente_mapeo_REST_eng_20.png?nolink&30|}} | + | The calculated JSONPath / XPath value can be copied to the clipboard by clicking on the button |
| + | {{Asistente_mapeo_REST_eng_20.png?nolink&30|}} | ||
webservice_adaptor.1733930158.txt.gz · Last modified: 2024/12/11 15:15 by montse
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 3.0 Unported
