POST api/Activities/{id}/Execute

Executes an activity non-interactively and retrieves its output.

Request

Parameters

Name Description Default
id Unique activity ID, activity name or GUID.

Body

Content Type: application/xml or application/json
Key/value pairs representing the input to the activity.

XML JSON 
<Request>                    <!--Array of 'Item'--> 
  <Item>                     
    <Name>string</Name>      
    <Value>object</Value>    
  </Item>                    
</Request>                   
[{                      
   "Name": "string",    
   "Value": "object"    
}]

Response

Body

Content Type: application/xml or application/json
Key/value pairs representing the output from the activity (if any).

XML JSON 
<Response>                     
  <Result>                     <!--Array of 'Item'--> 
    <Item>                     
      <Name>string</Name>      
      <Value>object</Value>    
    </Item>                    
  </Result>                    
  <Message>string</Message>    <!--Error message--> 
</Response>                    
{                          
   "Result": [{            
      "Name": "string",    
      "Value": "object"    
   }],                     
   "Message": "string"     // Error message
}

Status Codes

Code Condition
200 OK The operation completed successfully.
400 Bad RequestInvalid activity.
401 Unauthorized Access token is invalid, expired or not specified.
403 ForbiddenUser does not have permission to start the activity.
404 Not FoundActivity not found.
406 Not Acceptable Content type specified in the Accept header isn't supported.
409 ConflictThe activity was cancelled.
500 Internal Server Error An internal error occurred.

Remarks

Only activities which are explicitly marked 'non-interactive' can be executed using this method.

The input, output and internal behaviour of an activity are determined by the activity type.