Community forum

Welcome Guest! To enable all features please Login or Register.

Notification

Icon
Error

Options
View
Go to last post Go to first unread
Offline ErikC  
#1 Posted : Friday, July 10, 2015 8:44:45 AM(UTC)
ErikC

Rank: Paid support

Joined: 2/26/2008(UTC)
Posts: 1,520
Netherlands
Location: Amsterdam

Thanks: 114 times
Was thanked: 220 time(s) in 188 post(s)
Hi,

I looked at the web API documentation (http://localhost:8001/VisualCron/text/Docs) and there are a few typos in there with parameters:

Is the parameter strName or name?
/// <summary>
/// Get a Job
/// </summary>
/// <param name="strName">Job name</param>
/// <returns type="JobClass"></returns>
/// <fields>id,name,description,active,group,runonce,removeafterexecution,runtasksinorder,notstartifrunning,queuejobs,runmissed,createdby,modifiedby</fields>
/// <link type="text">http://localhost:8001/VisualCron/text/Job/GetByName?token={token}&name={strName}</link>
/// <link type="xml">http://localhost:8001/VisualCron/xml/Job/GetByName?token={token}&name={strName}</link>
/// <link type="json">http://localhost:8001/VisualCron/json/Job/GetByName?token={token}&name={strName}</link>


The parameter runToTask is mispelled
/// <summary>
/// Run a Job
/// </summary>
/// <param name="id">Job Id</param>
/// <param name="checkConditions">[Optional] Check conditions (true/false)</param>
/// <param name="synchronous">[Optional] Run synchronous (true/false)</param>
/// <param name="runFromTask">[Optional] Run from a specified Task (true/false)</param>
/// <param name="runFromTaskId">[Optional] Run from Task Id</param>
/// <param name="runToTask">[Optional] Run to a specified Task (true/false)</param>
/// <param name="runToTaskId">[Optional] Run to Task Id</param>
/// <returns type="JobRunResultClass"></returns>
/// <link type="text">http://localhost:8001/VisualCron/text/Job/Run?token={token}&id={id}&checkConditions={checkConditions}&synchronous={synchronous}&runFromTask={runFromTask}&runFromTaskId={runFromTaskId}&runToask={runToTask}&runToTaskId={runToTaskId}</link>
/// <link type="xml">http://localhost:8001/VisualCron/xml/Job/Run?token={token}&id={id}&checkConditions={checkConditions}&synchronous={synchronous}&runFromTask={runFromTask}&runFromTaskId={runFromTaskId}&runToask={runToTask}&runToTaskId={runToTaskId}</link>
/// <link type="json">http://localhost:8001/VisualCron/json/Job/Run?token={token}&id={id}&checkConditions={checkConditions}&synchronous={synchronous}&runFromTask={runFromTask}&runFromTaskId={runFromTaskId}&runToask={runToTask}&runToTaskId={runToTaskId}</link>

Job_Run JobRunResultClass (String id, Boolean checkConditions, Boolean synchronous, Boolean runFromTask, String runFromTaskId, Boolean runToTask, String runToTaskId)


The parameter is id not jobId
/// <summary>
/// List all Tasks within a Job
/// </summary>
/// <param name="jobId">Job Id</param>
/// <returns type="TaskClass[]"></returns>
/// <fields>id,name,tasktype,active,jobid,order,codepage</fields>
/// <link type="text">http://localhost:8001/VisualCron/text/Task/List?token={token}&id={id}</link>
/// <link type="xml">http://localhost:8001/VisualCron/xml/Task/List?token={token}&id={id}</link>
/// <link type="json">http://localhost:8001/VisualCron/json/Task/List?token={token}&id={id}</link>

Task_List TaskClass[] (String jobId)


The parameter should have a upper case i in jobId
/// <summary>
/// Remove a Task
/// </summary>
/// <param name="jobId">Job Id</param>
/// <param name="taskId">Task Id</param>
/// <returns type="Boolean"></returns>
/// <link type="text">http://localhost:8001/VisualCron/text/Task/Remove?token={token}&jobid={jobid}&taskId={taskId}</link>
/// <link type="xml">http://localhost:8001/VisualCron/xml/Task/Remove?token={token}&jobid={jobid}&taskId={taskId}</link>
/// <link type="json">http://localhost:8001/VisualCron/json/Task/Remove?token={token}&jobid={jobid}&taskId={taskId}</link>

Task_Remove Boolean (String jobId, String taskId)


The parameter should have a upper case i in jobId
/// <summary>
/// Run a Task
/// </summary>
/// <param name="jobId">Job Id</param>
/// <param name="taskId">Task Id</param>
/// <param name="checkConditions">[Optional] Check conditions (true/false)</param>
/// <param name="synchronous">[Optional] Run synchronous (true/false)</param>
/// <returns type="TaskRunResultClass"></returns>
/// <link type="text">http://localhost:8001/VisualCron/text/Task/Run?token={token}&jobid={jobid}&taskId={taskId}&checkConditions={checkConditions}&synchronous={synchronous}</link>
/// <link type="xml">http://localhost:8001/VisualCron/xml/Task/Run?token={token}&jobid={jobid}&taskId={taskId}&checkConditions={checkConditions}&synchronous={synchronous}</link>
/// <link type="json">http://localhost:8001/VisualCron/json/Task/Run?token={token}&jobid={jobid}&taskId={taskId}&checkConditions={checkConditions}&synchronous={synchronous}</link>

Task_Run TaskRunResultClass (String jobId, String taskId, Boolean checkConditions, Boolean synchronous)


The parameter should have a upper case i in jobId
/// <summary>
/// Stop a Task
/// </summary>
/// <param name="jobId">Job Id</param>
/// <param name="taskId">Task Id</param>
/// <returns type="Boolean"></returns>
/// <link type="text">http://localhost:8001/VisualCron/text/Task/Stop?token={token}&jobid={jobid}&taskId={taskId}</link>
/// <link type="xml">http://localhost:8001/VisualCron/xml/Task/Stop?token={token}&jobid={jobid}&taskId={taskId}</link>
/// <link type="json">http://localhost:8001/VisualCron/json/Task/Stop?token={token}&jobid={jobid}&taskId={taskId}</link>

Task_Stop Boolean (String jobId, String taskId)


The parameter should have a upper case i in jobId
/// <summary>
/// Activate a Task
/// </summary>
/// <param name="jobId">Job Id</param>
/// <param name="taskId">Task Id</param>
/// <returns type="Boolean"></returns>
/// <link type="text">http://localhost:8001/VisualCron/text/Task/Activate?token={token}&jobid={jobid}&taskId={taskId}</link>
/// <link type="xml">http://localhost:8001/VisualCron/xml/Task/Activate?token={token}&jobid={jobid}&taskId={taskId}</link>
/// <link type="json">http://localhost:8001/VisualCron/json/Task/Activate?token={token}&jobid={jobid}&taskId={taskId}</link>

Task_Activate Boolean (String jobId, String taskId)


The parameter should have a upper case i in jobId
/// <summary>
/// Deactivate a Task
/// </summary>
/// <param name="jobId">Job Id</param>
/// <param name="taskId">Task Id</param>
/// <returns type="Boolean"></returns>
/// <link type="text">http://localhost:8001/VisualCron/text/Task/DeActivate?token={token}&jobid={jobid}&taskId={taskId}</link>
/// <link type="xml">http://localhost:8001/VisualCron/xml/Task/DeActivate?token={token}&jobid={jobid}&taskId={taskId}</link>
/// <link type="json">http://localhost:8001/VisualCron/json/Task/DeActivate?token={token}&jobid={jobid}&taskId={taskId}</link>

Task_DeActivate Boolean (String jobId, String taskId)


The parameter should have a upper case i in jobId
/// <summary>
/// Get Task output
/// </summary>
/// <param name="jobId">Job Id</param>
/// <param name="taskId">Task Id</param>
/// <param name="outputType">[Optional] Output type (Standard/Error)</param>
/// <returns type="String"></returns>
/// <link type="text">http://localhost:8001/VisualCron/text/Task/Output?token={token}&jobid={jobid}&taskId={taskId}&outputType={outputType}</link>
/// <link type="xml">http://localhost:8001/VisualCron/xml/Task/Output?token={token}&jobid={jobid}&taskId={taskId}&outputType={outputType}</link>
/// <link type="json">http://localhost:8001/VisualCron/json/Task/Output?token={token}&jobid={jobid}&taskId={taskId}&outputType={outputType}</link>

Task_Output String (String jobId, String taskId, String outputType)

Edited by user Friday, July 10, 2015 8:45:33 AM(UTC)  | Reason: also a typo ;-)

Uses Visualcron since 2006.
Offline Support  
#2 Posted : Friday, July 10, 2015 9:32:41 AM(UTC)
Support

Rank: Official support

Joined: 2/23/2008(UTC)
Posts: 11,222

Thanks: 875 times
Was thanked: 446 time(s) in 424 post(s)
Thanks, we will fix this for next build.
Henrik
Support
http://www.visualcron.com
Please like VisualCron on facebook!
Users browsing this topic
Guest
You cannot post new topics in this forum.
You cannot reply to topics in this forum.
You cannot delete your posts in this forum.
You cannot edit your posts in this forum.
You cannot create polls in this forum.
You cannot vote in polls in this forum.

Scroll to Top