ProcessData
Use this resource to retrieve process details, such as milestones, activities, and activity properties.
Method summary
HTTP Method | Path | Description |
---|---|---|
GET | /scr/api/ProcessData | Retrieves details about a process. |
GET /scr/api/ProcessData
- Description
- Use this method to retrieve process details, such as milestones, activities, and activity properties.
- Resource information
-
Requirements Description Response format JSON Requires authentication Yes. The user must have at least participant access to the process. Supports OAuth 2 client credentials Yes using a User Service ID containing Artifact Reporting Category Rate limited Not yet
- Parameters
-
Name Location Description Required Type X-On-Behalf-Of Header The user context. The value must be a username in the account. The user must have permission to perform the action in the account and in the specified parent space, if any. Required if Service ID OAuth credentials are used. Not required when using User Service ID OAuth credential. String processId Query The ID of the process to retrieve. Yes String
- Response
- The data is returned as a map of items. Each item in an account has a unique ID; the
ID values link all items in the account together.
- Example input
-
- Using OAuth 2 client
credentials:
curl -i -H "Authorization: Bearer access_token" "https://your_server_url/scr/api/ProcessData?processId=100005"
- Using OAuth 2 client
credentials:
- Example output
-
{ "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" } }
- Response properties
-
- accessControl
- The access properties that the requesting user has for the process.
- activities
- The array that contains IDs of sub activities of an activity. For the root activity, sub activities are milestones.
- attachedEvents
- The array that contains IDs of attached events of an activity.
- association
- The association between the activity and the annotation for a linked text annotation.
- associationFrom
- The ID of the activity that has the text annotation.
- associationTo
- The ID of the text annotation.
- businessOwners
- The array that contains IDs of any business owners who are linked to the
activity. Each entry in the array is an object with a single
val
property that holds ID of the business ownerACTOR
item. - childComments
- The array that contains IDs of replies to the comment. Each entry in the
array is an object with a single
val
property that holds the ID of theCOMMENT
item. - comments
- The array that contains IDs of any comments that are linked to the
activity. Each entry in the array is an object with a single
val
property that holds the ID of theCOMMENT
item. - cost
- A number that represents the cost.
- createdByName
- The name of the user who created the comment.
- createdByUserId
- The ID of the user who created the comment.
- createdDate
- The millisecond value that represents when the comment was created.
- customers
- The array that contains the IDs of customers associated with the activity.
Each entry in the array is an object with a single
val
property that holds the ID of theSUPPLIERCUSTOMER
item. - cycleTime
- The cycle time value that is expressed with a number followed by a
character unit marker.
Character unit marker Description m
minutes h
hours d
days w
weeks M
months - deleted
- The indication of whether the data for the file was deleted. The possible
values are
true
orfalse
. - diagram
- The ID of the diagram, if the process has one. The
diagram
item itself is not present in the data. - experts
- The array with the IDs of any experts that are linked to the activity.
Each entry in the array is an object with a single
val
property that holds the ID of the expertACTOR
item. - files
- The
files
map. Thekey
is the ID of the file, and thevalue
is the object with the file's properties. - fileItemId
- The ID of the file in the
files
map. This property can be used with theFileDownload
to download contents of the file. - fileItems
- The array with the IDs of file items that are linked to the activity. Each
entry is an object with a
val
property that holds the ID of thefileItem
item and thefileItemId
property that holds the ID of an entry in thefiles
map. Thefiles
map entry contains information about the file. - frequency
- The frequency with which the problem occurs. The values are classified in
the following way:
- Less than 3 is Low
- Less than 9 and more than 3 is Medium
- 9 or more is High
- 1 for Low
- 3 for Medium
- 9 for High
- hideOnMap
- Indicates whether the user chose to hide the item from the map view in Blueworks Live.
- inputs
- The array with the IDs of any inputs linked to the activity. Each entry in
the array is an object with a single
val
property that holds the ID of theINPUTOUTPUT
item. - isAuthor
- This boolean access control property indicates whether the user who makes the request has author access to the process.
- isRead
- The value of
true
is set if the comment was read. - items
- The
items
map that has one entry for each item. Thekey
is the item ID, and thevalue
is the object with the item's properties. - itemType
- The type of item.
Item type value Description Item type properties ACTIVITY
Any item, including milestones, is an activity on the map or the diagram. The majorType
property distinguishes between differentsubtypes
of an activity.ACTOR
A person or a role. Actors are used for participants, business owners, and experts. itemType
andName
COMMENT
A comment The name
property of the comment is the comment text.FILEITEM
A file No properties. Information about the file is in the files
map. Look at the documentation for thefileItems
property.INPUTOUTPUT
Something that can be used as an input or an output. itemType
andName
PROBLEM
A problem itemType
andName
PROCESS
A process itemType
andName
PROJECT
A project itemType
andName
SYSTEM
A system itemType
andName
SUPPLIERCUSTOMER
An item that can be used as a supplier or a customer itemType
andName
TEXT_ANNOTATION
A text annotation itemType
,Name
,associationFrom
,associationTo
- majorType
- The type of activity that the item represents. This property is present
only for
ACTIVITY
items.Activity type Description activity
Normal activity endEvent
End event in the diagram gateway
Gateway in the diagram intermediateEvent
Intermediate event (such as message, error, or timer event) in the diagram intermediateEventAttached
Intermediate event (such as message, error, or timer event) attached to an activity in the diagram linkedprocess
Link to another process milestone
Milestone startEvent
Start event in the diagram subprocess
Subprocess - name
- The name of the item.
- For a
comment
item, the name is the actual comment text. - For a
process
item, the name of the process is in the name of the root activity in therootActivityId
property.
- For a
- outputs
- The array with the IDs of any outputs linked to the activity. Each entry
in the array is an object with a single
val
property that holds the ID of theINPUTOUTPUT
item. - participants
- The value is the ID of a single participant
ACTOR
item associated with an activity. - problems
- The array of links to
PROBLEM
items. Each entry in the array is an object with aval
property, which is the ID of the linkedproblem
item and optionalfrequency
andseverity
properties. - process
- The property of a comment with the ID of the process that the comment is associated with.
- processId
- The ID of the process. The
items
map contains an entry for this ID. - project
- The property of the
PROCESS
item with the ID of thePROJECT
item that represents the project that the process is in. - risk
- The amount of risk the activity introduces to the process. The risk is
represented with one of the following numeric values.
Risk value Description 1 Controlled 2 Low 3 Medium 4 High - rootActivityID
- The ID of the top-level activity in the process. This property is not displayed on the map or diagram. Its children are the milestones.
- severity
- The severity of a problem. The values are classified in the following way:
- Less than 3 is Low
- More than 3 and less than 9 is Medium
- 9 or more is High
- 1 for Low
- 3 for Medium
- 9 for High
- size
- The property of an item in the files array holding the size of the file in bytes.
- suppliers
- The array that contains the IDs of any suppliers associated with the
activity. Each entry in the array is an object with a single
val
property that holds the ID of theSUPPLIERCUSTOMER
item. - systems
- The array of links to
SYSTEM
items. Each entry in the array is an object with a singleval
property that holds the ID of theSYSTEM
item. - type
- The property of the item in the files array that defines the type of the
file.
Type value Description 1 Generic document. Used if the file doesn't fall under one of the other values. 2 Microsoft Excel file 3 Image 4 PDF document 5 Microsoft PowerPoint document 6 Microsoft Project document 7 Microsoft Visio document 8 Microsoft Word document - val
- The ID of another item.
- valueAdd
- One of the following numeric values represents whether the activity adds
value to the process.
Numeric value Description 1 Yes 2 No 3 Required
- Response messages
-
HTTP code Reason 200 The request was completed successfully.
401 The user isn't authorized to make the request.
403 The user does not have access to the process.