getInfo

Retrieves ArkManager's overall information.

Request

<arkConfigInfo>
   <getInfo type=" ">
      <jobName/>
   </getInfo>
</arkConfigInfo>

Reply

<arkConfigInfo>
   <getInfo>
      <arkConfig>
         <basic/>
         <defaults/>
         <job/>
      </arkConfig>
   </getInfo>
</arkConfigInfo>
<result value="">
   <description/>
</result>

Elements

jobName

(Optional) Specifies the name of the job. You can pass the word “defaults” to this element. Multiple jobName elements are acceptable. If no jobName is specified, all arkConfig information (including information defined by the basic element) is returned.

basic

Specifies that jobName wasn't specified in the request, so all basic information is returned.

defaults

Specifies that defaults was passed as the value to jobName in the request, so all default information is returned.

job

(Repeating) Specifies the job information for each requested job.

result

Specifies an error value or zero (for no error).

description

Specifies a text description of the returned result.

Attributes

type

(Optional) Specifies the type of information to return: full or simple. The default value is full. If full is specified, information defined by the job and defaults elements is returned. If simple is specified, only information defined by the job element is returned.