APIを使用したトリガーの登録について

Orchestrator(クラウド版ではなく、オンプレ)で、
Web APIを使用してトリガー登録(スケジュール登録)しようとしています。

https://(orchestratorのホスト名)/swagger/ui/index#

これを参考にしていますが、
恐らく POST /odata/ProcessSchedules が目的のAPIだと思いますが、
パラメータの ProcessScheduleDto の詳細な値の説明がありません。

もう少し詳細なマニュアル等、どなたかご存じないでしょうか?

こちらの画面が見えているかと思います。この画面の右下にある Data Type の、Model をクリックしますとDTOに含まれる設定項目と設定可能な値の説明が記載されています。

急ぎ抜粋しますと、当方で確認したもの(2018.4)では下記の内容となっています。これを読み解きつつPOSTしたいJSONを構成していく動きになるかと思います。
日本語のドキュメントについては当方では確認したことがないので、必要であれば翻訳を利用しながら勧めていただければと思います。

ProcessScheduleDto {
Enabled (boolean, optional): Specifies if the schedule is active or not. ,
Name (string): The name of the schedule. ,
ReleaseId (integer, optional): The Id of the process associated with the schedule. ,
ReleaseKey (string, optional): The unique key of the process associated with the schedule. ,
ReleaseName (string, optional): The name of the process associated with the schedule. ,
PackageName (string, optional): The name of the package to be triggered with the schedule. ,
EnvironmentName (string, optional): The name of the environment associated with the schedule. ,
EnvironmentId (string, optional): The Id of the environment associated with the schedule. ,
StartProcessCron (string, optional): The start cron expression of the schedule. ,
StartProcessCronDetails (string, optional): Various details that can be associated to the time period expression of the schedule. ,
StartProcessCronSummary (string, optional): Human readable form of cron expression of the schedule. ,
StartProcessNextOccurrence (string, optional): The date and time when the associated process will be run next. ,
StartStrategy (integer, optional): States which robots from the environment are being run by the schedule. ,
ExecutorRobots (Array[RobotExecutorDto], optional): The collection of specific robots selected to be targeted by the current schedule. This collection must be empty if the start strategy is not 0 (specific robots). ,
StopProcessExpression (string, optional): The cron expression after which a running process will be stopped. ,
StopStrategy (string, optional): The way a running process is stopped. = ['SoftStop', 'Kill']stringEnum:"SoftStop", "Kill",
ExternalJobKey (string, optional): The unique identifier of the external job associated with the jobs generated by this schedule. A key is generated for each group of jobs triggered by this schedule. ,
TimeZoneId (string, optional): The timezone under which the schedule will run. ,
TimeZoneIana (string, optional): The timezone under which the schedule will run in Iana Standard. ,
UseCalendar (boolean, optional): Specify whether the schedule uses the bank holiday calendar ,
StopProcessDate (string, optional),
InputArguments (string, optional): Input parameters that will be passed to each job created by this schedule. ,
Id (integer, optional)
}
2 Likes

ご回答ありがとうございます。

Modelをクリックすると説明が出るのですね。
どうやら見落としていたようです。ありがとうございました。

1 Like

This topic was automatically closed 3 days after the last reply. New replies are no longer allowed.