Fetch Inputs Specification for a Workflow

Description:

An API method to obtain the list of run-time parameters, along with a flag indicating whether the parameter is required or optional.

Usage:

http://Orchestrator_IP_address/aspera/orchestrator/api/workflow_inputs_spec/158?login=admin&password=aspera

The required input parameter, which specifies the workflow ID, is the following:

workflow_reporter /workflow_inputs_spec/workflow_id

Response example (XML):

<?xml version="1.0"?>
<workflow_inputs_spec time="2015-04-30 16:19:21 UTC" action="inputs_spec">
  <workflow_name>ADI Ingest</workflow_name>
  <workflow_id>158</workflow_id>
      <parameter id="288" name="md5_check">
        <workflow_id>158</workflow_id>
        <value_type>flag</value_type>
        <optional>false</optional>
        <value></value>
      </parameter>
    
      <parameter id="290" name="filesize_check">
        <workflow_id>158</workflow_id>
        <value_type>flag</value_type>
        <optional>false</optional>
        <value></value>
      </parameter>
    
      <parameter id="289" name="dtd_check">
        <workflow_id>158</workflow_id>
        <value_type>flag</value_type>
        <optional>false</optional>
        <value></value>
      </parameter>
</workflow_inputs_spec>

Response example (JSON):

{  
   "workflow_inputs_spec":{  
      "workflow_id":122,
      "time":"2016-01-12 19:11:57",
      "parameter":[  
         {  
            "name":"path_to_xml",
            "value_type":"string",
            "optional":true,
            "value":"undefi",
            "id":246
         },
         {  
            "name":"asset_path",
            "value_type":"string",
            "optional":true,
            "value":"undef",
            "id":247
         }
      ],
      "action":"inputs_spec",
      "workflow_name":"Sub_Fileprep_action"
   }
}{  
   "workflow_inputs_spec":{  
      "workflow_id":1,
      "time":"2016-01-12 19:13:20",
      "parameter":[  

      ],
      "action":"inputs_spec",
      "workflow_name":"fanout test"
   }
}