XPP REST Client Query Para

Question

What should a query string format be to execute a POST against XPP Server via XPP Rest API client? The help does not make much sense. When executed, it is asking for a Process ID number 
 
 Run XPP commands on a Division or Job. 
 NOTE: The 'command' parameter is the program to run and must be located in the 'xz/bin' directory. For example, divtrace, divflags, show_xref, see Command Line Utilities 
 The caller is responsible for all options. 
 
 GET 
 /xpp/docs/:path/processes/command 
 Parameter

Field 
 Type 
 Description

command 
 String 
 
 The name of the XPP commmand (in xz/bin) to run

options optional 
 String 
 
 Additional 'command' options

ecode optional 
 String 
 
 error code for exit criteria 1 => OK if 0 >= exitcode < 128 (default=0)

path 
 String 
 
 The "logical" 4/5-part path to a Division or Job in the form "handle:class:group:job:div"

nowait optional 
 String 
 
 If "nowait=true", the command will return immediately with the id, code, and time the command started (default="false"). The user can check for command completion, by using the 'xpp/docs/processes/id' endpoint; where 'id' is the id used to get the status of the running program (default="false"). See Command Status for the command to determine the status of a 'nowait' program. 
 Allowed values: "true" , "false"

Matt Taylor · Accepted Answer

Hi all, 
 Good news! I have found the solution. The fix was in the options arguments and the query format string. I was not only able to get successful compose command using a REST API call but also execute the sdedit. See the correct query string format with options below: 
 servername:2995/.../sdedit div -aout MattTaylor -xml

XPP > XPP

XPP REST Client Query Para

Parameter

Top Replies