Hitachi

uCosminexus Service Coordinator Interactive Workflow システム構築・運用ガイド

付録I.13　各運用管理REST APIの詳細

各運用管理REST APIの詳細を説明します。

〈この項の構成〉

(1)　ビジネスプロセス定義の登録

指定されたビジネスプロセス定義ファイル（.hbx）をワーク管理データベースに登録し，活性化状態に変更します。

ビジネスプロセス定義の登録を反映するためには，該当するシステムID内で実行しているすべてのCSCIWManagementServer，およびCSCIWを使用しているJavaアプリケーションの再起動が必要です。

メソッドとURL
POST /v1/process-definition
リクエストボディ

項番

名前

型

指定要否

内容

1

UserDescription

文字列

省略可

ユーザ記述子を指定します。

ビジネスプロセス定義を登録する場合，ユーザ記述子の値がビジネスプロセス定義の作成者として登録されます。

省略した場合はデフォルト値が指定されます。空文字列は指定できません。

2

DefinitionFile

文字列

必須

登録するビジネスプロセス定義ファイルをbase64エンコードした文字列を指定します。

base64エンコードについては「付録I.11　リクエストパラメタにファイルを指定する方法」を参照してください。

  • BPMN連携機能を使用する場合

    ビジネスプロセス定義ファイルはciwtransbpmnコマンドで変換したファイルを使用してください。

    ciwtransbpmnコマンドについては，マニュアル「uCosminexus Service Coordinator Interactive Workflowコマンド」の「ciwtransbpmn（BPMNビジネスプロセス定義ファイルのCSCIWのビジネスプロセス定義ファイルへの変換）」を参照してください。

  • BPMN連携機能を使用しない場合

    ビジネスプロセス定義ファイルはCSCIW-Definerでチェックを実施したファイルを使用してください。

    CSCIW-Definerでのチェックについては，マニュアル「uCosminexus Service Coordinator Interactive Workflow ビジネスプロセス開発ガイド」の「ビジネスプロセス定義をチェックする」を参照してください。

リクエストボディの構造を次に示します。

項番

名前

出現回数

1

Parameter

1

2

UserDescription

0または1

3

DefinitionFile

1
リクエスト例

リクエストURL

POST http://restserver/csciwmngws/v1/process-definition

リクエストボディ（XMLの場合）

<?xml version="1.0" encoding="UTF-8" ?>
<Parameter>
  <DefinitionFile>PD94bWwgdmVyc2lvbj0nMS4wJyBlbmNvZGluZz0nVVRGLTgnPz48IURPQ1RZUEUgWE1JPjxYTUkgeG1pLnZlcnNpb249JzEuMCc+PC9YTUk+</DefinitionFile>
</Parameter>

リクエストボディ（JSONの場合）

{
  "DefinitionFile" : "PD94bWwgdmVyc2lvbj0nMS4wJyBlbmNvZGluZz0nVVRGLTgnPz48IURPQ1RZUEUgWE1JPjxYTUkgeG1pLnZlcnNpb249JzEuMCc+PC9YTUk+"
}
レスポンス

登録したビジネスプロセス定義を返します。ビジネスプロセス定義のプロパティを次に示します。

項番

名前

型

内容

1

Author

文字列

ビジネスプロセス定義の作成者

2

CreationDate

日付

ビジネスプロセス定義の作成日

3

Description

文字列

ビジネスプロセス定義の説明

4

ID

数値

ビジネスプロセス定義のID

5

Name

文字列

ビジネスプロセス定義の名称

6

Responsible

文字列

ビジネスプロセス定義の管理者ID

7

StateCode

文字列

ビジネスプロセス定義の状態

8

ValidFromDate

日付

ビジネスプロセス定義の有効となる日

9

ValidToDate

日付

ビジネスプロセス定義の無効となる日

10

Version

数値

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

レスポンスの構造を次に示します。

項番

名前

出現回数

1

ProcessDefinition

1

2

Author

1

3

CreationDate

1

4

Description

1

5

ID

1

6

Name

1

7

Responsible

1

8

StateCode

1

9

ValidFromDate

1

10

ValidToDate

1

11

Version

1
ステータスコード

項番

ステータスコード

内容

1

201

成功

2

400

リクエストパラメタの不正

3

500

内部処理エラー
レスポンス例

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ProcessDefinition>
  <Author>user1</Author>
  <CreationDate>2016-12-06T15:18:35+09:00</CreationDate>
  <Description></Description>
  <ID>3</ID>
  <Name>販売業務</Name>
  <Responsible>user1</Responsible>
  <StateCode>b</StateCode>
  <ValidFromDate>ORIGIN</ValidFromDate>
  <ValidToDate>BEYOND</ValidToDate>
  <Version>2</Version>
</ProcessDefinition>

JSONの場合

{
  "Author" : "user1",
  "CreationDate" : "2016-12-06T15:18:35+09:00",
  "Description" : "",
  "ID" : "3",
  "Name" : "販売業務",
  "Responsible" : "user1",
  "StateCode" : "b",
  "ValidFromDate" : "ORIGIN",
  "ValidToDate" : "BEYOND",
  "Version" : "2"
}

ページの先頭へ

(2)　ビジネスプロセス定義の削除

指定されたビジネスプロセス定義を非活性化してから削除します。指定されたビジネスプロセス定義がすでに非活性であった場合，ビジネスプロセス定義の削除だけを行います。ただし，削除対象のビジネスプロセス定義に案件が存在するときは，ビジネスプロセス定義を非活性化および削除できません。

ビジネスプロセス定義が削除済み，または削除対象のビジネスプロセス定義が存在しない場合，リクエストは成功し，ステータスコード204を返します。

ビジネスプロセス定義の削除を反映するためには，該当するシステムID内で実行しているすべてのCSCIWManagementServer，およびCSCIWを使用しているJavaアプリケーションの再起動が必要です。

メソッドとURL
DELETE /v1/process-definition
クエリパラメタ

項番

名前

型

指定要否

内容

1

userdescription

文字列

省略可

ユーザ記述子を指定します。

省略した場合はデフォルト値が指定されます。

空文字列は指定できません。

2

name

文字列

必須

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

3

version

数値

必須

ビジネスプロセス定義バージョンを指定します。
リクエスト例

リクエストURL

DELETE http://restserver/csciwmngws/v1/process-definition?name=BP001&version=1
レスポンス

レスポンスボディは空になります。

ステータスコード

項番

ステータスコード

内容

1

204

成功

2

400

リクエストパラメタの不正

3

500

内部処理エラー
レスポンス例

レスポンスボディは空になります。

ページの先頭へ

(3)　振り分けルール定義の登録

指定された振り分けルール定義ファイル（.hcx）をワーク管理データベースに登録し，活性化状態に変更します。

振り分けルール定義の登録を反映するためには，該当するシステムID内で実行しているすべてのCSCIWManagementServer，およびCSCIWを使用しているJavaアプリケーションの再起動が必要です。

メソッドとURL
POST /v1/casting-rule
リクエストボディ

項番

名前

型

指定要否

内容

1

UserDescription

文字列

省略可

ユーザ記述子を指定します。

振り分けルール定義を登録する場合，ユーザ記述子の値が振り分けルール定義の作成者として登録されます。

省略した場合はデフォルト値が指定されます。空文字列は指定できません。

2

DefinitionFile

文字列

必須

登録する振り分けルール定義ファイルをbase64エンコードした文字列を指定します。

base64エンコードについては，「付録I.11　リクエストパラメタにファイルを指定する方法」を参照してください。

振り分けルール定義ファイルはCSCIW-Definerでチェックを実行してから登録してください。CSCIW-Definerでのチェックについては，マニュアル「uCosminexus Service Coordinator Interactive Workflowビジネスプロセス開発ガイド」の「振り分けルール定義をチェックする」を参照してください。

リクエストボディの構造を次に示します。

項目

名前

出現回数

1

Parameter

1

2

UserDescription

0または1

3

DefinitionFile

1
リクエスト例

リクエストURL

POST http://restserver/csciwmngws/v1/casting-rule

リクエストボディ（XMLの場合）

<?xml version="1.0" encoding="UTF-8" ?>
<Parameter>
<DefinitionFile>PD94bWwgdmVyc2lvbj0nMS4wJyBlbmNvZGluZz0nU2hpZnRfSklTJz8+PCFET0NUWVBFIFhNST48WE1JIHhtaS52ZXJzaW9uPScxLjAnPjwvWE1JPg==</DefinitionFile>
</Parameter>

リクエストボディ（JSONの場合）

{
  "DefinitionFile": "PD94bWwgdmVyc2lvbj0nMS4wJyBlbmNvZGluZz0nU2hpZnRfSklTJz8+PCFET0NUWVBFIFhNST48WE1JIHhtaS52ZXJzaW9uPScxLjAnPjwvWE1JPg=="
}
レスポンス

登録した振り分けルール定義を返します。振り分けルール定義のプロパティを次に示します。

項目

名前

型

内容

1

Author

文字列

振り分けルール定義の作成者

2

CreationDate

日付

振り分けルール定義の作成日

3

Description

文字列

振り分けルール定義の説明

4

ID

数値

振り分けルール定義のID

5

Name

文字列

振り分けルール定義の名称

6

Responsible

文字列

振り分けルール定義の管理者ID

7

StateCode

文字列

振り分けルール定義の状態

8

ValidFromDate

日付

振り分けルール定義の有効となる日

9

ValidToDate

日付

振り分けルール定義の無効となる日

10

Version

数値

振り分けルール定義のバージョン

レスポンスの構造を次に示します。

項目

名前

出現回数

1

CastingRule

1

2

Author

1

3

CreationDate

1

4

Description

1

5

ID

1

6

Name

1

7

Responsible

1

8

StateCode

1

9

ValidFromDate

1

10

ValidToDate

1

11

Version

1
ステータスコード

項目

ステータスコード

内容

1

201

成功

2

400

リクエストパラメタの不正

3

500

内部処理エラー
レスポンス例

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CastingRule>
  <Author>user1</Author>
  <CreationDate>2019-10-06T15:18:35+09:00</CreationDate>
  <Description></Description>
  <ID>12</ID>
  <Name>CastSQL</Name>
  <Responsible>user1</Responsible>
  <StateCode>b</StateCode>
  <ValidFromDate>ORIGIN</ValidFromDate>
  <ValidToDate>BEYOND</ValidToDate>
  <Version>2</Version>
</CastingRule>

JSONの場合

{
  "Author" : "user1",
  "CreationDate" : "2019-10-06T15:18:35+09:00",
  "Description" : "",
  "ID" : "12",
  "Name" : "CastSQL",
  "Responsible" : "user1",
  "StateCode" : "b",
  "ValidFromDate" : "ORIGIN",
  "ValidToDate" : "BEYOND",
  "Version" : "2"
}

ページの先頭へ

(4)　振り分けルール定義の削除

指定された振り分けルール定義を非活性状態にしてから削除します。ただし，削除対象の振り分けルール定義がビジネスプロセス定義で使用されているときは，非活性化および削除することはできません。

指定された振り分けルール定義の状態がすでに非活性であった場合，振り分けルール定義の削除だけを行います。

振り分けルール定義が削除済み，または削除対象の振り分けルール定義が存在しない場合，リクエストは成功し，ステータスコード204を返します。

振り分けルール定義の削除を反映するためには，該当するシステムID内で実行しているすべてのCSCIWManagementServer，およびCSCIWを使用しているJavaアプリケーションの再起動が必要です。

メソッドとURL
DELETE /v1/casting-rule
クエリパラメタ

項番

名前

型

指定要否

内容

1

userdescription

文字列

省略可

ユーザ記述子を指定します。

省略した場合はデフォルト値が指定されます。空文字列は指定できません。

2

name

文字列

必須

振り分けルール定義名を指定します。

3

version

数値

必須

振り分けルール定義バージョンを指定します。
リクエスト例

リクエストURL

DELETE http://restserver/csciwmngws/v1/casting-rule?name=RULE001&version=1
レスポンス

レスポンスボディは空になります。

ステータスコード

項番

ステータスコード

内容

1

204

成功

2

400

リクエストパラメタの不正

3

500

内部処理エラー
レスポンス例

レスポンスボディは空になります。

ページの先頭へ

(5)　ジョブの投入

ジョブを投入します。

ジョブは非同期で実行されるため，このAPIのレスポンスからジョブの実行結果を確認することはできません。投入したジョブの実行結果を確認するには，ジョブレコードの取得APIを実行してください。

メソッドとURL
POST /v1/job/create
リクエストボディ

項番

名前

型

指定要否

内容

1

UserDescription

文字列

省略可

ユーザ記述子を指定します。

省略した場合はデフォルト値が指定されます。空文字列は指定できません。

2

FunctionName

文字列

必須

ジョブの機能を表すファンクション名を指定します。

機能ごとのファンクション名の詳細は，「付録I.14　投入するジョブの機能ごとの指定値と戻り値」を参照してください。

3

ArgumentDataList

配列

省略可

ジョブの機能に渡す引数データを指定します。

機能ごとの引数データの詳細は，「付録I.14　投入するジョブの機能ごとの指定値と戻り値」の各機能の引数データを参照してください。

4

Data

オブジェクト

必須

データオブジェクトを指定します。

次の2つの要素（KeyおよびValue）から構成されます。

5

Key

文字列

必須

データのキー名を指定します。

空文字列は指定できません。

6

Value

文字列

省略可

データのキーに対応する値を指定します。

省略した場合，キーに対応する値は設定されずにnullが指定されます。空文字列は指定できません。

リクエストボディの構造を次に示します。

項番

名前

出現回数

1

Parameter

1

2

UserDescription

0または1

3

FunctionName

1

4

ArgumentDataList

0または1

5

Data

1以上

6

Key

1

7

Value

0または1
リクエスト例

リクエストURL

POST http://restserver/csciwmngws/v1/job/create

リクエストボディ（XMLの場合）

<?xml version="1.0" encoding="UTF-8" ?>
<Parameter>
  <FunctionName>delpi</FunctionName>
  <ArgumentDataList>
    <Data>
      <Key>DaysFromClosedDate</Key>
      <Value>3</Value>
    </Data>
    <Data>
      <Key>ProcessDefinitionName</Key>
      <Value>販売業務</Value>
    </Data>
    <Data>
      <Key>ProcessDefinitionVersion</Key>
      <Value>5</Value>
    </Data>
    <Data>
      <Key>IsAll</Key>
      <Value>true</Value>
    </Data>
    <Data>
      <Key>Name</Key>
    </Data>
    <Data>
      <Key>Unit</Key>
      <Value>30</Value>
    </Data>
  </ArgumentDataList>
</Parameter>

リクエストボディ（JSONの場合）

{
  "FunctionName" : "delpi",
  "ArgumentDataList" : {
    "Data" : [
      {
        "Key" : "DaysFromClosedDate",
        "Value" : "3"
      },
      {
        "Key" : "ProcessDefinitionName",
        "Value" : "販売業務"
      },
      {
        "Key" : "ProcessDefinitionVersion",
        "Value" : "5"
      },
      {
        "Key" : "IsAll",
        "Value" : "true"
      },
      {
        "Key" : "Name"
      },
      {
        "Key" : "Unit",
        "Value" : "30"
      }
    ]
  }
}
レスポンス

投入したジョブのジョブレコードを返します。ジョブレコードの詳細については，「付録I.2(2)　ジョブレコードの取得による非同期処理の実行状況の確認」を参照してください。

ジョブレコードのプロパティを次に示します。

項番

名前

型

内容

1

ArgumentDataList

配列

ジョブが使用する引数データ

2

ClosedDate

日付

ジョブの終了日時

3

Creator

文字列

ジョブの投入者

4

FunctionName

文字列

ジョブのファンクション名

5

ID

数値

ジョブのジョブID

6

ResultDataList

配列

ジョブの結果データ

7

ReturnCode

文字列

ジョブのリターンコード

8

StartDate

日付

ジョブの開始日時

9

StateCode

文字列

ジョブの状態

レスポンスの構造を次に示します。

項番

名前

出現回数

1

Job

1

2

ArgumentDataList

1

3

Data

0または1以上

4

Key

1

5

Value

0または1

6

ClosedDate

1

7

Creator

1

8

FunctionName

1

9

ID

1

10

ResultDataList

1

11

Data

0または1以上

12

Key

1

13

Value

0または1

14

ReturnCode

1

15

StartDate

1

16

StateCode

1

ジョブの実行結果を確認するには，レスポンスとして返却されるジョブのジョブID（ID）を使用して，ジョブレコードの取得APIを実行してください。

ステータスコード

項番

ステータスコード

内容

1

202

成功（Accepted）

2

400

リクエストパラメタの不正

3

500

内部処理エラー
レスポンス例

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Job>
  <ArgumentDataList>
    <Data>
      <Key>DaysFromClosedDate</Key>
      <Value>3</Value>
    </Data>
    <Data>
      <Key>ProcessDefinitionName</Key>
      <Value>販売業務</Value>
    </Data>
    <Data>
      <Key>ProcessDefinitionVersion</Key>
      <Value>5</Value>
    </Data>
    <Data>
      <Key>IsAll</Key>
      <Value>true</Value>
    </Data>
    <Data>
      <Key>Name</Key>
    </Data>
    <Data>
      <Key>Unit</Key>
      <Value>30</Value>
    </Data>
  </ArgumentDataList>
  <ClosedDate></ClosedDate>
  <Creator>csciwmngws</Creator>
  <FunctionName>delpi</FunctionName>
  <ID>1481005115000</ID>
  <ResultDataList></ResultDataList>
  <ReturnCode></ReturnCode>
  <StartDate>2016-12-06T15:18:35+09:00</StartDate>
  <StateCode>d</StateCode>
</Job>

JSONの場合

{
  "ArgumentDataList" : {
    "Data" : [
      {
        "Key" : "DaysFromClosedDate",
        "Value" : "3"
      },
      {
        "Key" : "ProcessDefinitionName",
        "Value" : "販売業務"
      },
      {
        "Key" : "ProcessDefinitionVersion",
        "Value" : "5"
      },
      {
        "Key" : "IsAll",
        "Value" : "true"
      },
      {
        "Key" : "Name"
      },
      {
        "Key" : "Unit",
        "Value" : "30"
      }
    ]
  },
  "ClosedDate" : "2016-12-06T15:19:53+09:00",
  "Creator" : "csciwmngws",
  "FunctionName" : "delpi",
  "ID" : "1481005115000",
  "ResultDataList" : "",
  "ReturnCode" : "",
  "StartDate" : "2016-12-06T15:18:35+09:00",
  "StateCode" : "d"
}

ページの先頭へ

(6)　ジョブレコードの取得

指定されたジョブIDのジョブレコードを取得します。

メソッドとURL
GET /v1/job/<ジョブID>※

注※　<ジョブID>：取得するジョブレコードのジョブのID（必須）

クエリパラメタ

項番

名前

型

指定要否

内容

1

userdescription

文字列

省略可

ユーザ記述子を指定します。

省略した場合はデフォルト値が指定されます。空文字列は指定できません。
リクエスト例

リクエストURL

GET http://restserver/csciwmngws/v1/job/1481005115000
レスポンス

指定されたジョブレコードを返します。レスポンスのジョブレコードの詳細については，「付録I.2(2)　ジョブレコードの取得による非同期処理の実行状況の確認」を参照してください。

ジョブレコードのプロパティを次に示します。

項番

名前

型

内容

1

ArgumentDataList

配列

ジョブが使用する引数データ

2

ClosedDate

文字列

ジョブの終了日時

3

Creator

文字列

ジョブの投入者

4

FunctionName

日付

ジョブのファンクション名

5

ID

文字列

ジョブのジョブID

6

ResultDataList

配列

ジョブの結果データ

7

ReturnCode

文字列

ジョブのリターンコード

8

StartDate

文字列

ジョブの開始日時

9

StateCode

文字列

ジョブの状態

レスポンスの構造を次に示します。

項番

名前

出現回数

1

Job

1

2

ArgumentDataList

1

3

Data

0または1以上

4

Key

1

5

Value

0または1

6

ClosedDate

1

7

Creator

1

8

FunctionName

1

9

ID

1

10

ResultDataList

1

11

Data

0または1以上

12

Key

1

13

Value

0または1

14

ReturnCode

1

15

StartDate

1

16

StateCode

1

ジョブの結果データ（ResultDataList）およびジョブのリターンコード（ReturnCode）の詳細は，「付録I.14　投入するジョブの機能ごとの指定値と戻り値」を参照してください。

ステータスコード

項番

ステータスコード

内容

1

200

成功

2

400

リクエストパラメタの不正

3

404

データが見つからなかった

4

500

内部処理エラー
レスポンス例

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Job>
  <ArgumentDataList>
    <Data>
      <Key>DaysFromClosedDate</Key>
      <Value>3</Value>
    </Data>
  </ArgumentDataList>
  <ClosedDate>2016-12-06T15:19:53+09:00</ClosedDate>
  <Creator>csciwmngws</Creator>
  <FunctionName>delpi</FunctionName>
  <ID>1481005115000</ID>
  <ResultDataList>
    <Data>
      <Key>NumOfDeletedPI</Key>
      <Value>2078</Value>
    </Data>
    <Data>
      <Key>NumOfDeletedChildPI</Key>
      <Value>122</Value>
    </Data>
  </ResultDataList>
  <ReturnCode>0</ReturnCode>
  <StartDate>2016-12-06T15:18:35+09:00</StartDate>
  <StateCode>o</StateCode>
</Job>

JSONの場合

{
  "ArgumentDataList" : {
    "Data" : [
      {
        "Key" : "DaysFromClosedDate",
        "Value" : "3"
      }
    ]
  },
  "ClosedDate" : "2016-12-06T15:19:53+09:00",
  "Creator" : "csciwmngws",
  "FunctionName" : "delpi",
  "ID" : "1481005115000",
  "ResultDataList" : {
    "Data" : [
       {
         "Key" : "NumOfDeletedPI",
         "Value" : "2078"
       },
     {
        "Key" : "NumOfDeletedChildPI",
        "Value" : "122"
      }
    ]
  },
  "ReturnCode" : "0",
  "StartDate" : "2016-12-06T15:18:35+09:00",
  "StateCode" : "o"
}

ページの先頭へ

(7)　ジョブレコードの一覧取得

指定された条件に該当するジョブレコードの一覧を取得します。ジョブレコードの一覧は開始時刻日時でソートされます。

メソッドとURL
GET /v1/job
クエリパラメタ

項番

名前

型

指定要否

内容

1

userdescription

文字列

省略可

ユーザ記述子を指定します。

省略した場合はデフォルト値が指定されます。デフォルト値はセットアッププロパティファイルのMngRestServiceUserDescriptionの値が使用されます。空文字列は指定できません。

2

functionname

文字列

省略可

検索条件としてファンクション名を指定します。

省略した場合は検索条件としてファンクション名を使用しません。

3

statecode

文字列

省略可

検索条件としてジョブレコードの状態を指定します。

複数の状態を指定する場合は，状態のコード値を同時に指定します。例えば「正常終了（o）」，「異常終了（v）」のジョブレコードを取得する場合は"ov"と指定します。ジョブの状態のコード値については，

「付録I.2(2)　ジョブレコードの取得による非同期処理の実行状況の確認」を参照してください。

省略した場合は検索条件としてジョブの状態を使用しません。

空文字列は指定できません。

4

creator

文字列

省略可

検索条件として投入者を指定します。

省略した場合は検索条件として投入者を使用しません。

5

sort

文字列

省略可

取得するジョブレコード一覧のソート順を指定します。

  • ASC：開始日時の昇順にソートします。

  • DESC：開始日時の降順にソートします。

省略した場合は昇順（ASC）でソートされます。空文字列は指定できません。

6

offset

数値

省略可

取得するジョブレコード一覧のオフセットを指定します。

先頭は0になります。省略した場合は0が指定されます。0未満の値は指定できません。

7

maxcount

数値

省略可

取得するジョブレコード一覧の最大取得数を指定します。

省略した場合はデフォルト値が指定されます。デフォルト値はセットアッププロパティファイルのMngRestServiceResponseMaxCountの値が使用されます。すべてを取得する場合は，-1を指定します。-1未満の値は指定できません。

リクエスト例

リクエストURL

GET http://restserver/csciwmngws/v1/job?functionname=delpi&statecode=do&creator=csciwmngws&sort=ASC
レスポンス

検索条件に該当するジョブレコードの一覧を返します。ジョブレコードの詳細については，「付録I.2(2)　ジョブレコードの取得による非同期処理の実行状況の確認」を参照してください。

ジョブレコードのプロパティを次に示します。

項番

名前

型

内容

1

ArgumentDataList

配列

ジョブが使用する引数データ

2

ClosedDate

日付

ジョブの終了日時

3

Creator

文字列

ジョブの投入者

4

FunctionName

文字列

ジョブのファンクション名

5

ID

数値

ジョブのジョブID

6

ResultDataList

配列

ジョブの結果データ

7

ReturnCode

文字列

ジョブのリターンコード

8

StartDate

日付

ジョブの開始日時

9

StateCode

文字列

ジョブの状態

レスポンスの構造を次に示します。

項番

名前

出現回数

1

Jobs

1

2

Job

0または1以上

3

ArgumentDataList

1

4

Data

0または1以上

5

Key

1

6

Value

0または1

7

ClosedDate

1

8

Creator

1

9

FunctionName

1

10

ID

1

11

ResultDataList

1

12

Data

0または1以上

13

Key

1

14

Value

0または1

15

ReturnCode

1

16

StartDate

1

17

StateCode

1

ジョブの結果データ（ResultDataList）およびジョブのリターンコード（ReturnCode）の詳細は，「付録I.14　投入するジョブの機能ごとの指定値と戻り値」を参照してください。

ステータスコード

項番

ステータスコード

内容

1

200

成功（データが０件の場合も成功）

2

400

リクエストパラメタの不正

3

500

内部処理エラー
レスポンス例

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Jobs>
  <Job>
    <ArgumentDataList>
      <Data>
        <Key>DaysFromClosedDate</Key>
        <Value>3</Value>
      </Data>
    </ArgumentDataList>
    <ClosedDate></ClosedDate>
    <Creator>csciwmngws</Creator>
    <FunctionName>delpi</FunctionName>
    <ID>1482412942222</ID>
    <ResultDataList></ResultDataList>
    <ReturnCode></ReturnCode>
    <StartDate>2016-12-22T22:22:22+09:00</StartDate>
    <StateCode>d</StateCode>
  </Job>
  <Job>
    <ArgumentDataList>
      <Data>
        <Key>DaysFromClosedDate</Key>
        <Value>10</Value>
      </Data>
    </ArgumentDataList>
    <ClosedDate>2016-12-06T15:19:53+09:00</ClosedDate>
    <Creator>csciwmngws</Creator>
    <FunctionName>delpi</FunctionName>
    <ID>1481005115000</ID>
    <ResultDataList>
      <Data>
        <Key>NumOfDeletedPI</Key>
        <Value>2078</Value>
      </Data>
      <Data>
        <Key>NumOfDeletedChildPI</Key>
        <Value>122</Value>
      </Data>
    </ResultDataList>
    <ReturnCode>0</ReturnCode>
    <StartDate>2016-12-06T15:18:35+09:00</StartDate>
    <StateCode>o</StateCode>
  </Job>
</Jobs>

JSONの場合

{
  "Job" : [
    {
      "ArgumentDataList" : {
        "Data" : [
          {
            "Key" : "DaysFromClosedDate",
            "Value" : "3"
          }
        ]
      },
      "ClosedDate" : "",
      "Creator" : "csciwmngws",
      "FunctionName" : "delpi",
      "ID" : "1482412942222",
      "ResultDataList" : "",
      "ReturnCode" : "0",
      "StartDate" : "2016-12-22T22:22:22+09:00",
      "StateCode" : "d"
    },
    {
      "ArgumentDataList" : {
        "Data" : [
          {
            "Key" : "DaysFromClosedDate",
            "Value" : "10"
          }
        ]
      },
      "ClosedDate" : "2016-12-06T15:19:53+09:00",
      "Creator" : "csciwmngws",
      "FunctionName" : "delpi",
      "ID" : "1481005115000",
      "ResultDataList" : {
        "Data" : [
          {
            "Key" : "NumOfDeletedPI",
            "Value" : "2078"
          },
          {
            "Key" : "NumOfDeletedChildPI",
            "Value" : "122"
          }
        ]
      },
      "ReturnCode" : "0",
      "StartDate" : "2016-12-06T15:18:35+09:00",
      "StateCode" : "o"
    }
  ]
}

ページの先頭へ

All Rights Reserved. Copyright (C) 2007, 2022, Hitachi, Ltd.