OpenScheduler: Operation

The OpenScheduler operation opens a scheduled tasks container and returns context that enables the user to work with its contents.

Comments

The operation enables the user to get access to the container and the tasks created in this container. To execute the operation, in the tOb parameter specify moniker of the object that is a scheduled tasks container, and in the tArg parameter specify parameters of opening. The object moniker can be obtained on executing the GetObjects operation. In the tArg.metaGet field specify the pattern, according to which container metadata is extracted on opening. If the tArg.metaGet field is not defined, the operation results only in the opened scheduled tasks container instance moniker.

Use the GeScheduler and SetScheduler operations to further work with the dictionary structure. To close an instance of scheduled tasks container, use the CloseScheduler operation.

Example

SOAP request:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

</tOb>

</OpenScheduler>

</s:Body>

</s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Body>

</id>

</OpenSchedulerResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "OpenScheduler" : 
  {
   "tOb" : 
    {
     "id" : "S1!M!6445"
    },
   "tArg" : ""
  }
}

JSON response:

{
 "OpenSchedulerResult" : 
  {
   "id" : 
    {
     "id" : "S1!M!6445"
    }
  }
}

The OpenTasksContainern function specified below opens a scheduled tasks container. The repository connection moniker and container identifier are passed as input parameters. The example uses the FindObjectById function, which code is given in the Getting Object Description by Its Identifier example. The result of the operation is the result of the function.

    public static OpenSchedulerResult OpenTasksContainern(MbId mb, string id)
    {
        var somClient = new SomPortTypeClient(); //Proxy object for operation execution
        //Operation execution parameters
        var tOpen = new OpenScheduler()
        {
            tArg = new OpenSchedulerArg(),
            tOb = new OdId() { id = mb.id + "!" + FindObjectById(mb, id).k }
        };
        //Open scheduled tasks container
        var tResult = somClient.OpenScheduler(tOpen);
        return tResult;
    }

OpenScheduler

Syntax