ページの先頭行へ戻る
Systemwalker Runbook Automation リファレンスガイド
Systemwalker
第5章 REST型のAPI > 5.1 APIリファレンス > 5.1.5 各APIのリファレンス
前次

5.1.5 各APIのリファレンス

5.1.5.1 プロセス定義のインターフェース

プロセス定義に関するインターフェースについて説明します。

Action

HTTPメソッド

URI

備考

プロセス定義を取得する

GET

/rbaserver/ProcessDefinitions

5.1.5.1.1 プロセス定義を取得する

機能説明

プロセス定義の一覧を取得します。

リクエストURI

/rbaserver/ProcessDefinitions

HTTPメソッド

GET

リクエストパラメーター

パラメーター名

必須

項目

項目説明

state

説明

プロセス定義の状態

型

string ASCII

設定内容

以下から選択します。複数指定する場合は、カンマ「,」区切りで指定します。

・「draft」 ： ドラフト状態のプロセス定義を検索します。

・「published」 : 公開状態のプロセス定義を検索します。

・「obsolete」 : 廃止されたプロセス定義を検索します。
本パラメーターを指定しない場合は、すべての状態が対象になります。

appid

説明

自動運用プロセスグループID

型

string UTF-8

設定内容

自動運用プロセスグループIDを指定します。本パラメーターを指定しない場合は、すべての自動運用プロセスグループIDが対象になります。

pdname

説明

プロセス定義名

型

string UTF-8

設定内容

プロセス定義名を指定します。本パラメーターを指定しない場合は、すべての自動運用プロセスグループIDが対象になります。

namematch

説明

検索条件

型

string ASCII

設定内容

pdnameパラメーターを指定した場合にプロセス定義名の検索パターンを指定します。省略した場合は完全一致で検索します。以下から選択します。

・「forward」 ： 前方一致

・「backward」 ： 後方一致

リクエストサンプル

GET /rbaserver/ProcessDefinitions HTTP/1.1
Host: rbamanager.systemwalker.fujitsu.com
Authorization: Basic c3dyYmFhZG1pbjpzeXN0ZW13YWxrZXIjMQ==

レスポンス

《ステータスコード》

以下のステータスコードを返します。

コード

説明

200 OK

リクエストが成功しました。リクエストを受付後の処理でエラーが発生した場合でも本コードを返します。

401 Unauthorized

認証情報が指定されていません。

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ProcessDefinitionResponse xmlns="http://rba.systemwalker.fujitsu.com">
    <responseStatus>[ステータス]</responseStatus>
    <responseMessage>[メッセージ]</responseMessage>
    <processDefinitions>
        <processDefinition>
            <applicationId>[自動運用プロセスグループID]</applicationId>
            <processId>[プロセスID]</processId>
            <name>[プロセス定義名]</name>
            <version>[バージョン]</version>
            <status>[状態]</status>
            <owner>[所有者]</owner>
            <lastupdate>[最終更新日]</lastupdate>
        </processDefinition>
    </processDefinitions>
</ProcessDefinitionResponse>

《要素》

要素名

項目

項目説明

ProcessDefinitionResponse

説明

レスポンス情報を持つ要素

型

なし

出現回数

1

responseStatus

説明

ステータス。詳細は、“5.2 レスポンスステータス・エラーコード”を参照してください。

型

string ASCII

出現回数

1

responseMessage

説明

メッセージ。詳細は、“5.3 レスポンスメッセージ”を参照してください。

型

string ASCII

出現回数

1

processDefinitions

説明

プロセス定義情報のレスポンス情報を持つ要素

型

なし

出現回数

0..1

processDefinition

説明

プロセス定義情報のレスポンス

型

なし

出現回数

0..*

applicationId

説明

自動運用プロセスグループID

型

string UTF-8

出現回数

1

processId

説明

プロセスID

型

string ASCII

出現回数

1

name

説明

プロセス定義名

型

string UTF-8

出現回数

1

version

説明

バージョン

型

string ASCII

出現回数

1

status

説明

プロセス定義の状態。以下が設定されます。

draft : ドラフト状態

published : 公開状態

obsolete : 廃止

deleted : 削除済み状態

private : 登録処理中および更新処理中の状態

型

string ASCII

出現回数

1

owner

説明

所有者

型

string UTF-8

出現回数

1

lastupdate

説明

最終更新日(GMT)

型

datetime

出現回数

1

レスポンスサンプル

<?xml version="1.0" encoding="UTF-8"?>
<ProcessDefinitionResponse xmlns="http://rba.systemwalker.fujitsu.com">
    <responseStatus>SUCCESS</responseStatus>
    <responseMessage>Process was completed.</responseMessage>
    <processDefinitions>
        <processDefinition>
            <applicationId>Sample</applicationId>
            <processId>10</processId>
            <name>Sample</name>
            <version>1.0</version>
            <status>draft</status>
            <owner>swrbaadmin</owner>
            <lastupdate>2011-04-27T05:49:56</lastupdate>
        </processDefinition>
    </processDefinitions>
</ProcessDefinitionResponse>

5.1.5.2 プロセスインスタンスのインターフェース

プロセスインスタンスに関するインターフェースについて説明します。

5.1.5.2.1 プロセスを起動する

機能説明

プロセスを起動します。

リクエストURI

/rbaserver/ProcessInstances

HTTPメソッド

POST

リクエストパラメーター

パラメーター名

必須

項目

項目説明

appid

○

説明

自動運用プロセスグループID

型

string UTF-8

設定内容

検索対象となる自動運用プロセスグループIDを指定します。

pdname

○

説明

プロセス定義名

型

string UTF-8

設定内容

プロセス定義名を指定します。

pdversion

説明

プロセス定義のバージョン

型

string ASCII

設定内容

プロセス定義のバージョンを指定します。本パラメーターを省略した場合は、最新バージョンを起動します。

リクエストボディ

起動するプロセスに必要なパラメーター情報を指定します。指定形式は、Javaのプロパティ形式です。

Content-Type に text/plain を指定し、文字コードはUTF-8で記載します。

パラメーター情報を指定しない場合でもContent-Typeは指定する必要があります。

リクエストサンプル

POST /rbaserver/ProcessInstances?appid=apl1&pdname=sample HTTP/1.1
Host: rbamanager.systemwalker.fujitsu.com:8009
Authorization: Basic c3dyYmFhZG1pbjpzeXN0ZW13YWxrZXIjMQ==
Content-type: text/plain; charset=utf-8

UDA1=value1
UDA2=value2

レスポンス

《ステータスコード》

以下のステータスコードを返します。

コード

説明

200 OK

リクエストが成功しました。リクエストを受付後の処理でエラーが発生した場合でも本コードを返します。

401 Unauthorized

認証情報が指定されていません。

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ProcessInstanceResponse xmlns="http://rba.systemwalker.fujitsu.com">
    <responseStatus>[ステータス]</responseStatus>
    <responseMessage>[メッセージ]</responseMessage>
</ProcessInstanceResponse>

《要素》

要素名

項目

項目説明

ProcessDefinitionResponse

説明

レスポンス情報を持つ要素

型

なし

出現回数

1

responseStatus

説明

ステータス。詳細は、“5.2 レスポンスステータス・エラーコード”を参照してください。

型

string ASCII

出現回数

1

responseMessage

説明

メッセージ。詳細は、“5.3 レスポンスメッセージ”を参照してください。

型

string ASCII

出現回数

1

processInstances

説明

プロセスインスタンス情報のレスポンス情報を持つ要素

型

なし

出現回数

0..1

processInstance

説明

プロセスインスタンス情報のレスポンス

型

なし

出現回数

0..*

id

説明

プロセスインスタンスID

型

string ASCII

出現回数

1

レスポンスサンプル

<?xml version="1.0" encoding="UTF-8"?>
<ProcessInstanceResponse xmlns="http://rba.systemwalker.fujitsu.com">
    <responseStatus>SUCCESS</responseStatus>
    <responseMessage>Process was completed.</responseMessage>
    <processInstances>
        <processInstance>
            <id>12013</id>
        </processInstance>
    </processInstances>
</ProcessInstanceResponse>
5.1.5.2.2 プロセスインスタンスの一覧を取得する

機能説明

プロセスインスタンスの一覧を取得します。

リクエストURI

/rbaserver/ProcessInstances

HTTPメソッド

GET

リクエストパラメーター

パラメーター名

必須

項目

項目説明

startedafter

説明

プロセスが起動された期間の開始日

型

string ASCII

設定内容

「yyyy-mm-dd」の形式で指定します。

startedbefore

説明

プロセスが起動された期間の終了日

型

string ASCII

設定内容

「yyyy-mm-dd」の形式で指定します。

state

説明

プロセス定義の状態

型

string ASCII

設定内容

以下の値を指定します。複数指定する場合はカンマ「,」で区切ります。

・「running」

・「closed」

・「suspended」

・「aborted」

・「created」

・「error」

piid

説明

プロセスインスタンスID

型

string ASCII

設定内容

プロセスインスタンスIDを指定します。複数指定する場合は、カンマ「,」で区切ります。本パラメーターを省略した場合は、すべてのプロセスインスタンスIDが対象になります。

pdname

説明

プロセス定義名

型

string UTF-8

設定内容

プロセス定義名を指定します。複数指定する場合は、カンマ「,」で区切ります。本パラメーターを省略した場合は、すべてのプロセス定義が対象となります。

namematch

説明

検索パターン

型

string ASCII

設定内容

プロセス定義名の検索パターンを指定します。省略した場合は完全一致で検索します。以下から選択します。

・「forward」 ： 前方一致

・「backward」 ： 後方一致

initiator

説明

プロセス起動ユーザーID

型

string ASCII

設定内容

プロセスを起動したユーザーIDを指定します。複数指定する場合は、カンマ「,」で区切ります。本パラメーターを省略した場合は、すべてのプロセス定義が対象となります。

appid

説明

自動運用プロセスグループID

型

string UTF-8

設定内容

検索対象となる自動運用プロセスグループIDを指定します。本パラメーターを省略した場合は、すべての自動運用プロセスグループを対象に検索します。

リクエストサンプル

GET /rbaserver/ProcessInstances?state=running&appid=TEST&pdname=Sample HTTP/1.1
Host: rbamanager.systemwalker.fujitsu.com:8009
Authorization: Basic c3dyYmFhZG1pbjpzeXN0ZW13YWxrZXIjMQ==

レスポンス

《ステータスコード》

以下のステータスコードを返します。

コード

説明

200 OK

リクエストが成功しました。リクエストを受付後の処理でエラーが発生した場合でも本コードを返します。

401 Unauthorized

認証情報が指定されていません。

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ProcessInstanceResponse xmlns="http://rba.systemwalker.fujitsu.com">
    <responseStatus>[ステータス]</responseStatus>
    <responseMessage>[メッセージ]</responseMessage>
    <processInstances>
        <processInstance>
            <id>[プロセスインスタンスID]</id>
            <name>[プロセス定義名]</name>
            <status>[状態]</status>
            <initiator>[起案者]</initiator>
        </processInstance>
    </processInstances>
</ProcessInstanceResponse>

《要素》

要素名

項目

項目説明

ProcessInstanceResponse

説明

レスポンス情報を持つ要素

型

なし

出現回数

1

responseStatus

説明

ステータス。詳細は、“5.2 レスポンスステータス・エラーコード”を参照してください。

型

string ASCII

出現回数

1

responseMessage

説明

メッセージ。詳細は、“5.3 レスポンスメッセージ”を参照してください。

型

string ASCII

出現回数

1

processInstances

説明

プロセスインスタンス情報のレスポンス情報を持つ要素

型

なし

出現回数

0..1

processInstance

説明

プロセスインスタンス情報のレスポンス

型

なし

出現回数

0..*

id

説明

プロセスインスタンスID

型

string ASCII

出現回数

1

name

説明

プロセスインスタンス名

型

string UTF-8

出現回数

1

status

説明

プロセスインスタンスの状態。以下のいずれかが設定されます。

・「running」

・「closed」

・「suspended」

・「aborted」

・「created」

・「error」

型

string ASCII

出現回数

1

initiator

説明

起案者

型

string UTF-8

出現回数

1

レスポンスサンプル

<?xml version="1.0" encoding="UTF-8"?>
<ProcessInstanceResponse xmlns="http://rba.systemwalker.fujitsu.com">
    <responseStatus>SUCCESS</responseStatus>
    <responseMessage>Process was completed.</responseMessage>
    <processInstances>
        <processInstance>
            <id>1234</id>
            <name>Sample</name>
            <status>running</status>
            <initiator>swrbaadmin</initiator>
        </processInstance>
    </processInstances>
</ProcessInstanceResponse>
5.1.5.2.3 プロセスインスタンスの詳細を取得する

機能説明

プロセスインスタンスの詳細情報を取得します。

リクエストURI

/rbaserver/ProcessInstances/{piid}

piid  :  プロセスインスタンスID

HTTPメソッド

GET

リクエストパラメーター

なし

リクエストサンプル

GET /rbaserver/ProcessInstances/1234 HTTP/1.1
Host: rbamanager.systemwalker.fujitsu.com
Authorization: Basic c3dyYmFhZG1pbjpzeXN0ZW13YWxrZXIjMQ==

レスポンス

《ステータスコード》

以下のステータスコードを返します。

コード

説明

200 OK

リクエストが成功しました。リクエストを受付後の処理でエラーが発生した場合でも本コードを返します。

401 Unauthorized

認証情報が指定されていません。

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ProcessInstanceResponse xmlns="http://rba.systemwalker.fujitsu.com">
    <responseStatus>[ステータス]</responseStatus>
    <responseMessage>[メッセージ]</responseMessage>
    <processInstances>
      [swrba_adminコマンド のpi-get同形式のXMLが入ります]
    </processInstances>
</ProcessInstanceResponse>

《要素》

要素名

属性

項目

項目説明

ProcessInstanceResponse

-

説明

レスポンス情報を持つ要素

型

なし

出現回数

1

responseStatus

-

説明

ステータス。詳細は、“5.2 レスポンスステータス・エラーコード”を参照してください。

型

string ASCII

出現回数

1

responseMessage

-

説明

メッセージ。詳細は、“5.3 レスポンスメッセージ”を参照してください。

型

string ASCII

出現回数

1

processInstances

-

説明

プロセスインスタンス情報のレスポンス情報を持つ要素

型

なし

出現回数

0..1

processInstance

-

説明

プロセスインスタンス情報のレスポンス

swrba_adminコマンドのpi-getで出力されるXML形式と同等です。詳細は、“2.4 プロセスインスタンス詳細情報ファイル”を参照してください。

型

なし

出現回数

0..1

レスポンスサンプル

<?xml version="1.0" encoding="UTF-8"?>
<ProcessInstanceResponse xmlns="http://rba.systemwalker.fujitsu.com">
    <responseStatus>SUCCESS</responseStatus>
    <responseMessage>Process was completed.</responseMessage>
    <processInstances>
        <Processinstance Completed="" Id="1598173" Initiator="swrbaadmin" Name="pilist_1" Owner="swrbaadmin" Started="2011-03-18 22:56:37" Status="running">
            <Node Form="" Id="1598174" Name="Start" Status="Completed" Type="Start"/>
            <Node Form="" Id="1598175" Name="Activity1" Status="Running" Timer="" Type="Activity"/>
            <Node Id="1598176" Name="Exit1" Status="Initial" Type="Exit"/>
            <UDA Name="A" Type="STRING" Value=""/>
            <UDA Name="B" Type="STRING" Value=""/>
            <History ConsumerId="1598173" ConsumerType="7" EventCode="0" EventData="" EventTYPE="__ProcessCreated" Id="1598179" IsHandled="4" ProducerId="1598173" ProducerType="7" Timestamp="2011-03-18 22:56:37"/>
            <History ConsumerId="1598173" ConsumerType="7" EventCode="0" EventData="" EventTYPE="__Start" Id="1598180" IsHandled="1" ProducerId="1598173" ProducerType="7" Timestamp="2011-03-18 22:56:38"/>
            <History ConsumerId="1598174" ConsumerType="3" EventCode="1" EventData="" EventTYPE="__Activate" Id="1598181" IsHandled="1" ProducerId="1598173" ProducerType="7" Timestamp="2011-03-18 22:56:38"/>
            <History ConsumerId="1598174" ConsumerType="3" EventCode="0" EventData="" EventTYPE="__NodeClosed" Id="1598182" IsHandled="4" ProducerId="1598174" ProducerType="3" Timestamp="2011-03-18 22:56:38"/>
            <History ConsumerId="1598175" ConsumerType="3" EventCode="1" EventData="" EventTYPE="Action 1" Id="1598183" IsHandled="1" ProducerId="1598177" ProducerType="0" Timestamp="2011-03-18 22:56:38"/>
        </Processinstance>
    </processInstances>
</ProcessInstanceResponse>
前次
Copyright 2010-2012 FUJITSU LIMITED