Trigger a Web API load job using a HTTP client - HxGN SDx - Update 64 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

You can trigger a Web API Loader job from any HTTP client like POSTMAN.

The following is a sample POST request to trigger a Web API loader job:

http://localhost/sdxserver/api/v2/SDA/SDVExecuteWebAPIJobDefinition

The following is an example of the request payload that can be used in the POST to trigger a Web API loader job:

{

ClassificationName : "<WebAPIReaderClassification>",

WorkflowToAttach: "HEX Web API Loader Workflow",

JobDescription: "Load Instruments using postman",

DataList: {"<dependent property value>" : "<dependent class definition>", "<dependent property value>" : "<dependent class definition>"},

EnvironmentVariables : {"SITENAME":"PID1", "PLANTNAME":"PLANTA" }

}