REST Consumer Activity Overview

v8.1 and earlier

Context

Use the REST Consumer Activity to invoke a method exposed by a RESTful Web service. Your workflow can then interact with this method and its data.

Important: REST service implementation does not support empty target name spaces.

Wizard Tips

Properties Tab

Parameter
Description
Base URL
You can append operations, such as posts, to the end of the URL, in which case it is not dynamic, or you can define the operations in the Operations tab.
Apply Custom Configuration
(Optional) Use this option to define and apply a custom configuration to the REST client configuration, for example, if you want to extend the headers.
  • Use Schemas to serialize the returned object and edits its properties, as necessary.
    • Before you add a schema, you must enter a valid configuration.
    • The schema must comply with Visual Studio structure standards. We recommend that you edit the schema in Visual Studio.
    • You can manually paste a schema into the text area, or you can upload a file with the schema. If you upload a file, the file type should be XSD.
    • Each schema entry must have a unique target namespace attribute.
    • If your schema includes an import or reference to other schemas, you must add them.

Operations Tab

Parameter
Description
URI Template
You can copy these parameters from the operation's URL, for example: http://jsonplaceholder.typicode.com/posts/{number}.
Request Parameter
This parameter cannot include spaces or special characters.

Request Bindings

  • Click method parameters in the left panel and assign input values to the method parameters in the right panel. You can enter the value as a hard-coded value, double-click a field from the workflow tree, or click to open the Expression Editor to define the value as the result of an expression.

v8.2 and later

Context

Use the REST Consumer Activity to invoke a method exposed by a RESTful Web service. Your workflow can then interact with this method and its data.

Important: REST service implementation does not support empty target name spaces.

 

Wizard Tips

Parameter
Description
Base URL
You can append operations, such as posts, to the end of the URL, in which case it is not dynamic, or you can define the operations in the Operations tab.
HTTPS consumption is supported.
Apply Custom Configuration
(Optional) Use this option to define and apply a custom configuration to the REST client configuration, for example, if you want to extend the headers.

Edit the con
  • Use Schemas to serialize the returned object and edits its properties, as necessary.
    • Before you add a schema, you must enter a valid configuration.
    • The schema must comply with Visual Studio structure standards. We recommend that you edit the schema in Visual Studio.
    • You can manually paste a schema into the text area, or you can upload a file with the schema. If you upload a file, the file type should be XSD.
    • Each schema entry must have a unique target namespace attribute.
    • If your schema includes an import or reference to other schemas, you must add them.

Operations Tab

Parameter
Description
URI Template
You can copy these parameters from the operation's URL, for example: http://jsonplaceholder.typicode.com/posts/{number}.
Request Parameter
This parameter cannot include spaces or special characters.

Request Bindings

  • Click method parameters in the left panel and assign input values to the method parameters in the right panel. You can enter the value as a hard-coded value, double-click a field from the workflow tree, or click to open the Expression Editor to define the value as the result of an expression.
About this Article
  • Created: 04/12/2017 3:57 am EDT
  • Last updated: 09/05/2017 7:51 am EDT
In This Article