ProcessData

マイルストーン、アクティビティー、アクティビティー・プロパティーなどのプロセスの詳細を取得するには、このリソースを使用します。

メソッドの要約

HTTP メソッド	パス	説明
取得	/scr/api/ProcessData	プロセスに関する詳細を取得します。

取得 /scr/api/ProcessData

説明: マイルストーン、アクティビティー、アクティビティー・プロパティーなどのプロセスの詳細を取得するには、このメソッドを使用します。

リソース情報

要件	説明
応答フォーマット	JSON
認証が必要	はい。ユーザーには、プロセスに対して少なくとも参加者権限が必要です。
OAuth 2 クライアント資格情報のサポート	はい (成果物レポート・カテゴリーを含むユーザー・サービス ID を使用)
指定時間内の数の制限	現在はなし

パラメーター

名前	Location	説明	必須	タイプ
X-On-Behalf-Of	ヘッダー	ユーザー・コンテキスト。値は、アカウントに含まれるユーザー名でなければなりません。ユーザーは、アカウント内と、親スペースを指定した場合はその親スペース内でアクションを実行する権限を持っている必要があります。	サービス ID OAuth 資格情報を使用する場合は必須です。ユーザー・サービス ID OAuth 資格情報を使用する場合は不要です。	ストリング
processId	照会	取得するプロセスの ID。	はい	ストリング

応答

データは項目のマップとして返されます。アカウント内の項目には、それぞれ固有の ID があります。ID 値によって、アカウント内のすべての項目が一まとまりになるようにリンクされます。

入力例

OAuth 2 クライアント資格情報の使用:

curl -i -H "Authorization: Bearer access_token" 
    "https://your_server_url/scr/api/ProcessData?processId=100005"

出力例

{
  "processId":"100005",
  "accessControl":{
    "isAuthor":"true"
  },  
   "items":{  
      "5f500e10929de":{  
         "positionFlowsRight":"false",
         "participants":"3d9200f4",
         "majorType":"activity",
         "textAnnotation": "5d1f04",
         "uiTaskIncludeAttach":"false",
         "uiTaskIncludeDoc":"false",
         "name":"Generate Conterct Document",
         "itemType":"ACTIVITY"
      },
      "5f500e110054b":{  
         "name":"myProb",
         "itemType":"PROBLEM"
      },
      "5f500e1092907":{ 
         "attachedEvents": [
            {
               "val": "5f500e57b6202"
            },
            {
               "val": "5f500e57b6206"
            },
            {
               "val": "5f500e57b620a"
            }
         ],  
         "businessOwners":[  
            {  
               "val":"5f500e1100507"
            }
         ],
         "activityDecisionDiagram":"5f500e109293d",
         "experts":[  
            {  
               "val":"5f500e110050f"
            }
         ],
         "uiTaskIncludeDoc":"false",
         "name":"Prequalify Vehicle",
         "cost":"10.00",
         "risk":"1",
         "outputs":[  
            {  
               "val":"3d92069b"
            }
         ],
         "majorType":"activity",
         "uiTaskIncludeAttach":"false",
         "customers":[  
            {  
               "val":"5f500e107002f"
            }
         ],
         "ruleType":"ruleDecision",
         "participants":"3d9200ee",
         "positionFlowsRight":"false",
         "waitTime":".64532m",
         "fileItems":[  
            {  
               "val":"5f500e11000fd",
               "fileItemId":"5f500e11000fb"
            }
         ],
         "systems":[  
            {  
               "val":"5f500e1100517"
            }
         ],
         "suppliers":[  
            {  
               "val":"5f500e1070032"
            }
         ],
         "inputs":[  
            {  
               "val":"3d920697"
            }
         ],
         "itemType":"ACTIVITY",
         "valueAdd":"3",
         "comments":[  
            {  
               "val":"5f500e1100574"
            }
         ],
         "problems":[  
            {  
               "val":"5f500e110054b",
               "frequency":"9",
               "severity":"9"
            },
            {  
               "val":"5f500e110055e"
            },
            {  
               "val":"5f500e1100563",
               "frequency":"3",
               "severity":"3"
            }
         ],
         "workTime":"20h",
         "activityPolicies":[  
            {  
               "val":"3d920015"
            }
         ]
      },
      "3d920015":{  
         "policyAbrvDesc":"This policy describes the special considerations for handling relocations of military families. Unlike other policyholders, military personnel and their families are often allowed to keep their insurance when moving out of the area.",
         "name":"Legal Handling of Military Family Moves out of State",
         "itemType":"POLICY",
         "itemParent":"3d920002"
      },
      "5f500e1092598":{  
         "name":"Validate Vehicle",
         "itemType":"DECISION_DIAGRAM",
         "itemParent":"5f500e10900d3"
      },
      "5f500e10928e2":{  
         "playbackPath":[  
            {  
               "val":"5f500e10928fd"
            }
         ],
         "playbackParent":"5f500e10928e0",
         "name":"Test Playback",
         "itemType":"PLAYBACK"
      },
      "5f500e1081072":{  
         "name":"Alternate Start Event",
         "itemType":"PROJECT"
      },
      "5f500e1100576":{  
         "isRead":"true",
         "createdByUserId":"7f0002",
         "createdDate":"1427234810125",
         "createdByName":"admin",
         "name":"reply",
         "itemType":"COMMENT",
         "ownerId":"5f500e10900d2"
      },
      "3d92069b":{  
         "name":"Activity Output 1",
         "itemType":"INPUTOUTPUT"
      },
      "5f500e11000fd":{  
         "itemType":"FILEITEM"
      },
      "5f500e10928f4":{  
         "positionFlowsRight":"false",
         "majorType":"milestone",
         "uiTaskIncludeAttach":"false",
         "uiTaskIncludeDoc":"false",
         "name":"Make final decisions",
         "itemType":"ACTIVITY",
         "activities":[  
            {  
               "val":"5f500e109297f"
            },
            {  
               "val":"5f500e1092981"
            },
            {  
               "val":"5f500e1092983"
            },
            {  
               "val":"5f500e1092985"
            }
         ]
      },
      "5f500e107002f":{  
         "name":"Activity Customer Search API",
         "itemType":"SUPPLIERCUSTOMER"
      },
      "5f500e109292e":{  
         "itemType":"FILEITEM"
      },
      "files":{  
      "5f500e11000fb":{  
         "size":"3.0",
         "deleted":false,
         "type":"9",
         "name":"bar.txt"
      }
   }
   "5d1f04": {
      "association": "5d1f06",
      "itemType": "TEXT_ANNOTATION",
      "name": "Activity text Annotation"
   },
   "5d1f06": {
      "associationFrom": "5d00c9",
      "associationTo": "5d1f04",
      "itemType": "ASSOCIATION",
      "name": ""
   },
   "5d1f0a": {
      "itemType": "TEXT_ANNOTATION",
      "name": "Process text annotation",
      "textAnnotationLaneId": "default_lane",
      "textAnnotationPosition": "2-3"
   }
   "5f500e57b6202": {
      "attachedEventPort": "2-4",
      "isPinned": "false",
      "itemType": "ACTIVITY",
      "majorType": "intermediateEventAttached",
      "name": "Message",
      "positionFlowsRight": "false",
      "uiTaskIncludeAttach": "false",
      "uiTaskIncludeDoc": "false"
   },
   "5f500e57b6206": {
      "attachedEventPort": "2-0",
      "isPinned": "false",
      "itemType": "ACTIVITY",
      "majorType": "intermediateEventAttached",
      "name": "Timer",
      "positionFlowsRight": "false",
      "uiTaskIncludeAttach": "false",
      "uiTaskIncludeDoc": "false"
   },
   "5f500e57b620a": {
      "attachedEventPort": "1-2",
      "isPinned": "false",
      "itemType": "ACTIVITY",
      "majorType": "intermediateEventAttached",
      "name": "Error",
      "positionFlowsRight": "false",
      "uiTaskIncludeAttach": "false",
      "uiTaskIncludeDoc": "false"
   }
}

応答プロパティー

accessControl

要求側のユーザーがプロセスに対して持っているアクセス権限のプロパティー。

activities

アクティビティーのサブアクティビティーの ID が含まれている配列。ルート・アクティビティーの場合、サブアクティビティーはマイルストーンです。

attachedEvents

アクティビティーの添付イベントの ID が含まれている配列。

association

リンクされたテキスト注釈のアクティビティーと注釈の関連。

associationFrom

テキスト注釈を持つアクティビティーの ID。

associationTo

テキスト注釈の ID。

businessOwners

アクティビティーにリンクされているすべてのビジネス・オーナーの ID が含まれている配列。配列内の各エントリーは、ビジネス・オーナーの ACTOR 項目の ID を保持する単一の val プロパティーを持つオブジェクトです。

childComments

コメントへの返信の ID が含まれている配列。配列内の各エントリーは、COMMENT 項目の ID を保持する単一の val プロパティーを持つオブジェクトです。

comments

アクティビティーにリンクされているすべてのコメントの ID が含まれている配列。配列内の各エントリーは、COMMENT 項目の ID を保持する単一の val プロパティーを持つオブジェクトです。

cost

コストを表す数値。

createdByName

コメントを作成したユーザーの名前。

createdByUserId

コメントを作成したユーザーの ID。

createdDate

コメントの作成時期を表すミリ秒値。

customers

アクティビティーに関連付けられた顧客の ID が含まれている配列。配列内の各エントリーは、SUPPLIERCUSTOMER 項目の ID を保持する単一の val プロパティーを持つオブジェクトです。

cycleTime

数値と、その後に続く 1 文字の単位マーカーで表される、サイクル・タイム値。

文字単位マーカー	説明
`m`	分
`h`	時
`d`	days
`w`	週間
`M`	月数

deleted

ファイルのデータが削除されたかどうかを示す標識。可能な値は、true または false です。

diagram

プロセスにダイアグラムがある場合は、そのダイアグラムの ID。 diagram項目自体はデータ内には存在しません。

experts

アクティビティーにリンクされているすべてのエキスパートの ID が含まれている配列。配列内の各エントリーは、エキスパートの ACTOR 項目の ID を保持する単一の val プロパティーを持つオブジェクトです。

files

files・マップ。 key はファイルの ID、value はファイルのプロパティーを持つオブジェクトです。

fileItemId

files・マップ内のファイルの ID。このプロパティーを FileDownload とともに使用して、ファイルのコンテンツをダウンロードすることができます。

fileItems

アクティビティーにリンクされているファイル項目の ID が含まれている配列。各エントリーは、fileItem 項目の ID を保持する val プロパティーと、files・マップ内のエントリーの ID を保持する fileItemId プロパティーを持つオブジェクトです。 files・マップのエントリーには、そのファイルに関する情報が含まれます。

frequency

問題の発生頻度。値は、次のように分類されます。

3 未満は「低」
9 未満で、3 以上は「中」
9 以上は「高」

IBM Blueworks Live は、以下の方法で値を設定します。

「低」に対しては 1
「中」に対しては 3
「高」に対しては 9

hideOnMap

ユーザーが Blueworks Liveのマップ・ビューで項目を非表示にすることを選択したかどうかを示します。

inputs

アクティビティーにリンクされているすべての入力の ID が含まれている配列。配列内の各エントリーは、INPUTOUTPUT 項目の ID を保持する単一の val プロパティーを持つオブジェクトです。

isAuthor

このブール値のアクセス制御プロパティーは、要求を出したユーザーが当該プロセスに対して作成者権限を持っているかどうかを示します。

isRead

コメントが既読である場合は、値 true が設定されます。

items

各項目に対してエントリーを 1 つ含んでいるitemsマップ。 key は項目 ID、value は項目のプロパティーを持つオブジェクトです。

itemType

項目のタイプ。

項目のタイプ値	説明	項目のタイプ・プロパティー
`ACTIVITY`	マイルストーンを含めて、どの項目も、マップやダイアグラム上のアクティビティーの 1 つです。	`majorType` プロパティーは、アクティビティーのさまざまな `subtypes` を区別します。
`ACTOR`	個人またはロール。 Actor は、参加者、ビジネス・オーナー、およびエキスパートに使用します。	`itemType` および `Name`
`COMMENT`	コメント	コメントの `name` プロパティーは、コメント・テキストを示します。
`FILEITEM`	ファイル	プロパティーはありません。ファイルに関する情報は、`files`・マップに含まれます。 `fileItems` プロパティーに関する資料を参照してください。
`INPUTOUTPUT`	入力または出力として使用できるもの。	`itemType` および `Name`
`PROBLEM`	問題	`itemType` および `Name`
`PROCESS`	プロセス	`itemType` および `Name`
`PROJECT`	プロジェクト	`itemType` および `Name`
`SYSTEM`	システム	`itemType` および `Name`
`SUPPLIERCUSTOMER`	提供者または顧客として使用できる項目。	`itemType` および `Name`
`TEXT_ANNOTATION`	テキスト注釈	`itemType`, `Name`, `associationFrom`, `associationTo`

majorType

項目が表しているアクティビティーのタイプ。このプロパティーは、ACTIVITY 項目の場合にのみ存在します。

アクティビティー・タイプ	説明
`activity`	標準アクティビティー
`endEvent`	ダイアグラム内の終了イベント
`gateway`	ダイアグラム内のゲートウェイ
`intermediateEvent`	ダイアグラム内の中間イベント (メッセージ、エラー、タイマー・イベントなど)
`intermediateEventAttached`	ダイアグラム内のアクティビティーに添付された中間イベント (メッセージ、エラー、タイマー・イベントなど)
`linkedprocess`	別のプロセスへのリンク
`milestone`	マイルストーン
`startEvent`	ダイアグラム内の開始イベント
`subprocess`	サブプロセス

name

項目の名前。

comment 項目の場合は、実際のコメント・テキストが名前になります。
process 項目の場合は、このプロセス名が rootActivityId プロパティーのルート・アクティビティー名に入ります。

outputs

アクティビティーにリンクされているすべての出力の ID の配列。配列内の各エントリーは、INPUTOUTPUT 項目の ID を保持する単一の val プロパティーを持つオブジェクトです。

participants

値は、アクティビティーと関連付けられている単一の参加者の ACTOR 項目の ID です。

problems

PROBLEM 項目へのリンクの配列。配列内の各エントリーは、リンクされた problem 項目の ID を示す val プロパティーと、オプションの frequency プロパティーおよび severity プロパティーを持つオブジェクトです。

process

コメントが関連付けられているプロセスの ID を持つコメントのプロパティー。

processId

プロセスの ID。 itemsマップには、この ID のエントリーが格納されます。

project

当該プロセスが含まれているプロジェクトを表す PROJECT 項目の ID を持つ PROCESS 項目のプロパティー。

risk

アクティビティーがプロセスに及ぼすリスクの量。リスクは、次のいずれかの数値で表されます。

リスク値	説明
1	制御
2	低速
3	中
4	高

rootActivityID

プロセス内のトップレベル・アクティビティーの ID。このプロパティーは、マップやダイアグラム上には表示されません。その子がマイルストーンになります。

severity

問題の重大度。値は、次のように分類されます。

3 未満は「低」
3 以上で 9 未満のものは「中」
9 以上は「高」

Blueworks Live は、以下の方法で値を設定します。

「低」に対しては 1
「中」に対しては 3
「高」に対しては 9

size

ファイルのサイズ (バイト単位) が格納された、ファイル配列内の項目のプロパティー。

suppliers

アクティビティーに関連付けられているすべての提供者の ID が含まれている配列。配列内の各エントリーは、SUPPLIERCUSTOMER 項目の ID を保持する単一の val プロパティーを持つオブジェクトです。

systems

SYSTEM 項目へのリンクの配列。配列内の各エントリーは、SYSTEM 項目の ID を保持する単一の val プロパティーを持つオブジェクトです。

type

ファイルのタイプを定義する、ファイル配列内の項目のプロパティー。

タイプ値	説明
1	一般文書。ファイルが他のどの値にも該当しない場合に使用されます。
2	Microsoft Excel ファイル
3	画像
4	PDF 文書
5	Microsoft PowerPoint 文書
6	Microsoft Project 文書
7	Microsoft Visio 文書
8	Microsoft Word 文書

val

別の項目の ID。

valueAdd

次の数値のいずれかによって、アクティビティーが当該プロセスに対して価値を付加するものであるかどうかが示されます。

数値	説明
1	はい
2	いいえ
3	必須

応答メッセージ

HTTP コード	理由
200	要求は正常に完了しました。
401	ユーザーには、要求を行う権限がありません。
403	ユーザーに、このプロセスへのアクセス権限がありません。