Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R9.0.0

Table of Contents
maxLevel2

GET workflow_rules/trigger

This method triggers an existing Workflow Rule. Only one Workflow rule can be triggered in each call.

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(mandatory)

...

Workflow Rule Identifier

The identifier of the Workflow Rule that should be triggered. The allowed Workflow Rule request identifier fields are the following:

...

entity

(mandatory)

...

The name of the Entity with which the Workflow Rule is related to . The supported entities are the following:

  • ACTIVITIES

...

entity_id

(mandatory)

...

fields_set

(optional)

...

List of Strings, comma separated 

...

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

...

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejs
linenumberstrue
 

 

Workflow Rule Request Data Structure Description

Activities

V4:activities_complete
Expand
titleView Data Structure
Include Page
V4:activities_complete
Panel
nameblue

Child pages (Children Display)
alltrue
excerpttrue