![]() |
Copyright © TIBCO Software Inc. All Rights Reserved |
Table 10 Invoke REST API Configuration Tab TIBCO ActiveMatrix BusinessWorksTM Plug-in for REST and JSON supports the following types of protocols: Note: This field is available only when the protocol type is None.
•
•
•
•
• Note: If the protocol type is WADL or Swagger, only the methods that correspond to the API are listed in the Method field. The response data type, which the Service Provider supports. TIBCO ActiveMatrix BusinessWorksTM Plug-in for REST and JSON provides the following options: Selecting this check box enables you to customize the data structure of the output activity in the Output Editor tab. See Output Editor for more information.If the response data is in binary format, ensure that the Rich Output check box is selected. Note: This field only appears when you select WADL as the protocol type. Note: This field only appears when you select Swagger as the protocol type. This activity supports Swagger 1.2 and 2.0 specifications. Header Send the access token in an HTTP header.Query Include the access token as a URL query parameter. If the WADL or Swagger file is changed, you must use the Reload button to refresh the WADL or Swagger file to update the Configuration and Input tabs.
•
•
−
−
−
You cannot alter the structure of the HTTP request message in the Input tab. If the data structure in the WADL file or Swagger file does not match the RESTful web service, edit the elements in the file and click Reload.Table 11 shows the rules for mapping a WADL file to the input parameters.
In a WADL file, if the style attribute value is template, the name of the parameter is mapped to the Template parameter in the Input tab.Note: During runtime, the parameters can be replaced with the input values in the Input tab. <resource path="/resource2/{format}">In this example, the format parameter is mapped to the input parameter. In a WADL file, if the style attribute value is query, two parts in a WADL file are mapped to the Query parameter:
• The param node directly under the resource tag: In this case, the Query parameter is shared by all the method nodes under this resource tag.
• The param node under the request tag: In this case, the Query parameter is only applicable for this method.
•
• In a WADL file, if the style attribute value is header, the name of the parameter is mapped to the Header parameter. In a WADL file, if the style attribute value is Query and the nodes are under the representation tag, the name of the parameter is mapped to the Form parameter, and is encoded in application/x-www-form-urlencoded. This input parameter always shows in the Input tab. This input parameter always shows in the Input tab. This input parameter always shows in the Input tab. Table 12 shows the rules for mapping a Swagger file to the input parameters.
In a Swagger file v1.2, if the paramType parameter value is path, the name of the parameter is mapped to the Template parameter in the Input tab. "name": "petId","name": "petId", In a Swagger file v1.2, if the paramType parameter value is query, the name of the parameter is mapped to the Query parameter in the Input tab. In this example, the query parameter is mapped to the input parameter. In a Swagger file v1.2, if the paramType parameter value is header, the name of the parameter is mapped to the Header parameter in the Input tab. In this example, the header parameter is mapped to the input parameter. In a Swagger file v1.2, if the paramType parameter value is form, the name of the parameter is mapped to the Form parameter in the Input tab. In this example, the form parameter is mapped to the input parameter.In this example, the formData parameter is mapped to the input parameter. This input parameter always shows in the Input tab. This input parameter always shows in the Input tab. This input parameter always shows in the Input tab. The description for the input parameters are shown in Table 13 for when the Protocol type is None.
You cannot alter the structure of the HTTP request message in the Input Editor tab. However, you can alter the child items under the three main parameters: Query, Header and body (including Form, Text, Binary, and Multipart). For example, add another param item under the Query parameter.
Specifies a URI query parameter for all methods that apply to the URI resource. The Query parameter is appended to the URL and is encoded in application/x-www-form-urlencoded. type This field must be defined according to content type encoding required by request. For example,content The content of the data for HTTP request. type In this field, specify the file name of the HTTP message attachment. TIBCO ActiveMatrix BusinessWorksTM Plug-in for REST and JSON converts the file name to the MIME type automatically.content The content of the HTTP message attachment.Note: If type and content parameters are not specified, the Binary parameter is ignored. See http://www.faqs.org/rfcs/rfc2388.html for more information.Note: If the Service Provider requires the multipart/mixed encoding, add a header x with the name Content-Type and set the value of this parameter to multipart/mixed.The Input Editor tab describes the data structure for the HTTP request message in the Input tab. If the Protocol type is WADL or Swagger, you can alter the element structure under the these parameters: Query, Header, and Body. See Table 13 for more details about each parameter.For more information about how to use the Input Editor tab, see "Specifying Data Schema" in TIBCO ActiveMatrix BusinessWorksTM Palette Reference.
Table 14 Invoke REST API Input The root and the path of a URI resource. The URI resource is set in the Resource URI field in the Configuration tab, but you can override the value by specifying the URI resource in this field. The items displayed under the Parameters item vary depending on whether the Enable WADL check box in the Configuration tab is selected. See Sending Data in the HTTP request for detailed information about the items. The name of the access token provided by the authorization server’s token endpoint. The access token name is set in the Token Name field in the Configuration tab, but you can override the value by specifying an access token name in this field. The value of the access token provided by the authorization server’s token endpoint. The access token value is set in the Token Value field in the Configuration tab, but you can override the value by specifying an access token value in this field. A valid user name for accessing a website. The user name is set in the Username field in the Configuration tab, but you can override the value by specifying a user name in this field. A valid password for accessing a website. The password is set in the Password field in the Configuration tab, but you can override the default by specifying a password in this field.The Output Editor tab describes the data structure in the Output tab. It allows you to add headers and set the response data type.
This tab is available only when the Rich Output check box is selected in the Configuration tab. When the Rich Output option is enabled, the output varies depending on the schema type defined in the Output Editor tab.For more information about how to use the Output Editor tab, see "Specifying Data Schema" in TIBCO ActiveMatrix BusinessWorksTM Palette Reference.
Table 15 Invoke REST API Output The Error Output tab lists the exceptions that can be generated by the Invoke REST API activity. See Trace Messages for more information about error codes.
Table 16 Invoke REST API Error Output
![]() |
Copyright © TIBCO Software Inc. All Rights Reserved |