Web Services Jobs

Determines the authorization credentials that are used to connect Control-M to Web Services REST, as described in Web Services REST Connection Profile Parameters.

Rules

• Characters: 1−30

• Case Sensitive: Yes

• Invalid Characters: Blank spaces.

Defines the endpoint base URL, which is the common resource prefix that the API uses to navigate.

Defines the URL request path.

Determines one of the following HTTP methods to run the REST job:

• GET: Reads or retrieves data from a resource.

• POST: Adds a new resource.

• DELETE: Deletes a resource.

• PUT: Updates an existing resource by entirely replacing its content.

• TRACE: Creates a loop-back test with the same request body that the user sent to the server. This is used for diagnostic purposes.

• HEAD: Determines the size of the data and allows you to test if a server is available.

• OPTIONS: Retrieves information about the possible communication options (HTTP methods) on the endpoint URL or the entire server.

• PATCH: Partially updates an existing resource by replacing some of its content.

Rules:

• Characters: 1−214

• Case-Sensitive: Yes

Variable Name: %%WS-SERVICE

Defines optional URL parameters, as Key:Value pairs.

Defines optional HTTP headers, as Key:Value pairs.

Determines whether to define a REST request body, and how to do so:

• Edit request body: Textual input of the body

• Specify only URL parameters and headers: No request body (only URL parameters and headers)

• Use a predefined request body from a local file

Defines the request body as textual input, in JSON format.

Defines the full path to a local file that contains a predefined request body.

(Optional) Defines output handling that extracts values from the service response in either JSON or XML.

The attribute consists of the following:

• HTTP Code: Defines the HTTP response or error code, in numbers or * (asterisk) for any code.

• Parameter/Path: Defines the parameter and its path in XPath or JsonPath format.

• CTM Variable/URI: Defines the Control-M variable or file to save the parameter value to, in the following format:

  • Local Variable: <parameter_name>

  • Smart Folder Variable: \\<parameter_name>

  • Named Pool Variable: \\\<parameter_name>

  • File: Defines the URI of the file in the following format:

    file:<full directory path and file name>

Rules:

• Each parameter must have a value.

• Maximum Rows: 999

Determines the number of seconds to wait after Control-M initiates a connection request before a timeout occurs.

Default: 50

Determines whether to append the API request to the output A tab in the job properties pane of the Monitoring domain where the job output appears that indicates whether a job ended OK, and is used, for example, with jobs that check file location..

Determines the authorization credentials that are used to connect Control-M to Web Services SOAP, as described in Web Services SOAP Connection Profile Parameters.

Rules

• Characters: 1−30

• Case Sensitive: Yes

• Invalid Characters: Blank spaces.

Defines the endpoint base URL, which is the common resource prefix that the API uses to navigate.

Defines a single SOAP action (operation), which you must take from the WSDL file.

<operation name="AddInteger">
<soap:operation soapAction="http://tempuri.org/SOAP.Demo.AddInteger"
 style="document"/>

Determines one of the following requests to perform:

• Edit SOAP Request

• Use a Predefined SOAP Request from a Local File

Defines the SOAP request.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:tem="http://tempuri.org">
<soapenv:Header/>
<soapenv:Body>
<tem:AddInteger>
<!-Optional:->
<tem:Arg1>1</tem:Arg1>
<!-Optional:->
<tem:Arg2>2</tem:Arg2>
</tem:AddInteger>
</soapenv:Body>
</soapenv:Envelope>

(Optional) Defines HTTP header key names and values.

(Optional) Defines the following output parameters:

• HTTP Code: Defines the HTTP response or error code, in numbers or * (asterisk) for any code.

• Parameter/Path: Defines the parameter and its path in XPath or JsonPath format.

• CTM Variable/URI: Defines the Control-M variable or file to save the parameter value to, in the following format:

  • Local Variable: <parameter_name>

  • Smart Folder Variable: \\<parameter_name>

  • Named Pool Variable: \\\<parameter_name>

  • File: Defines the URI of the file in the following format:

    file:<full directory path and file name>

Rules:

• Each parameter must have a value.

• Maximum Rows: 999

Determines the number of seconds to wait after Control-M initiates a connection request before a timeout occurs.

Default: 50

Determines whether to append the API request to the output A tab in the job properties pane of the Monitoring domain where the job output appears that indicates whether a job ended OK, and is used, for example, with jobs that check file location..