XaitCPQ API

POST action/run/{actionName}

Runs an action.

Request Information

URI

https://ofd-api.blueprintcpq.net/action/run/{actionName}

URI Parameters

NameDescriptionTypeAdditional information
actionName

The action name.

 string

Required

Body Parameters

None.

Response Information

Resource Description

A result object.

ActionRunResult
NameDescriptionTypeAdditional information
Result

ActionResult

None.
Message

string

None.
Data

DataTable

None.

Response Formats

application/json, text/json

Sample: 
{
  "Result": 0,
  "Message": "sample string 1",
  "Data": null
}

text/html

Sample: 
{"Result":0,"Message":"sample string 1","Data":null}

application/xml, text/xml

Sample: 
<ActionRunResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <Data i:nil="true" />
  <Message>sample string 1</Message>
  <Result>Success</Result>
</ActionRunResult>