Jump to

• Request
• Response
• Examples

Retrieve Data Objects for a Process Instance

get

/ic/api/process/v1/processes/{processId}/dataobjects

Retrieves data objects for a process instance at the process level.

Request

Path Parameters

• processId: string
  Value of process ID

Query Parameters

• includeInstanceAttributes(optional): boolean
  Include instance level attributes

  Default Value: false
• suspendInstance(optional): boolean
  Suspend Instance or not - to prevent the instance from moving between the time the user gets the open activities and work upon them

  Default Value: false
• type(optional): string
  Data Objects Structure Type - flat or tree

  Default Value: flat

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : ActivityFlowResponse

Type: object

Show Source

• dataVariableFlatTree(optional): array dataVariableFlatTree
• dataVariableTree(optional): object DataVariableNodeRes
• flowChanges(optional): array flowChanges
• levels(optional): integer(int32)
• links(optional): array links
• title(optional): string

{
    "type":"object",
    "properties":{
        "levels":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        },
        "links":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"links"
                },
                "$ref":"#/definitions/Link"
            }
        },
        "title":{
            "type":"string"
        },
        "dataVariableTree":{
            "$ref":"#/definitions/DataVariableNodeRes"
        },
        "dataVariableFlatTree":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariableNodeRes"
            }
        },
        "flowChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FlowChangeItemRes"
            }
        }
    }
}

Nested Schema : dataVariableFlatTree

Type: array

Show Source

• Array of: object DataVariableNodeRes

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DataVariableNodeRes"
    }
}

Nested Schema : DataVariableNodeRes

Type: object

Show Source

• children(optional): array children
• correlationKeyPropertyName(optional): object QName
• editable(optional): boolean
• levels(optional): integer(int32)
• links(optional): array links
• name(optional): string
• nodeType(optional): string
• scope(optional): string
• title(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "levels":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        },
        "links":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"links"
                },
                "$ref":"#/definitions/Link"
            }
        },
        "title":{
            "type":"string"
        },
        "children":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariableNodeRes"
            }
        },
        "correlationKeyPropertyName":{
            "$ref":"#/definitions/QName"
        },
        "editable":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "nodeType":{
            "type":"string"
        },
        "scope":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : flowChanges

Type: array

Show Source

• Array of: object FlowChangeItemRes

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/FlowChangeItemRes"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "xml":{
            "name":"links"
        },
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : children

Type: array

Show Source

• Array of: object DataVariableNodeRes

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DataVariableNodeRes"
    }
}

Nested Schema : QName

Type: object

Show Source

• localPart(optional): string
• namespaceURI(optional): string
• prefix(optional): string

{
    "type":"object",
    "properties":{
        "namespaceURI":{
            "type":"string"
        },
        "localPart":{
            "type":"string"
        },
        "prefix":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "xml":{
            "name":"links"
        },
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• mediaType(optional): string
• rel(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

Nested Schema : FlowChangeItemRes

Type: object

Show Source

• activityLocation(optional): string
• sourceActivity(optional): object OpenActivityInfo
• targetActivityId(optional): string
• targetGrabActivities(optional): array targetGrabActivities
• taskNumber(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "activityLocation":{
            "type":"string"
        },
        "sourceActivity":{
            "$ref":"#/definitions/OpenActivityInfo"
        },
        "taskNumber":{
            "type":"integer",
            "format":"int32"
        },
        "targetActivityId":{
            "type":"string"
        },
        "targetGrabActivities":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ActivityInfo"
            }
        }
    }
}

Nested Schema : OpenActivityInfo

Type: object

Show Source

• attributes(optional): array attributes
  Unique Items Required: true
• container(optional): boolean
• locationInfo(optional): object ILocationInfo
• path(optional): object ActivityPathInfo
• threadId(optional): integer(int32)
• workItemKeyURI(optional): string

{
    "type":"object",
    "properties":{
        "attributes":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/IVariableItem"
            }
        },
        "locationInfo":{
            "$ref":"#/definitions/ILocationInfo"
        },
        "path":{
            "$ref":"#/definitions/ActivityPathInfo"
        },
        "workItemKeyURI":{
            "type":"string"
        },
        "threadId":{
            "type":"integer",
            "format":"int32"
        },
        "container":{
            "type":"boolean"
        }
    }
}

Nested Schema : targetGrabActivities

Type: array

Show Source

• Array of: object ActivityInfo

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ActivityInfo"
    }
}

Nested Schema : attributes

Type: array

Unique Items Required: true

Show Source

• Array of: object IVariableItem

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/IVariableItem"
    }
}

Nested Schema : ILocationInfo

Type: object

Show Source

• activityInfo(optional): object IActivityInfo
• processInstanceInfo(optional): object IProcessInstanceInfo
• root(optional): boolean

{
    "type":"object",
    "properties":{
        "activityInfo":{
            "$ref":"#/definitions/IActivityInfo"
        },
        "processInstanceInfo":{
            "$ref":"#/definitions/IProcessInstanceInfo"
        },
        "root":{
            "type":"boolean"
        }
    }
}

Nested Schema : ActivityPathInfo

Type: object

Show Source

• endLocation(optional): object LocationInfo
• length(optional): integer(int32)
• locations(optional): object IterableILocationInfo
• startLocation(optional): object LocationInfo
• stringPath(optional): string

{
    "type":"object",
    "properties":{
        "locations":{
            "$ref":"#/definitions/IterableILocationInfo"
        },
        "stringPath":{
            "type":"string"
        },
        "startLocation":{
            "$ref":"#/definitions/LocationInfo"
        },
        "endLocation":{
            "$ref":"#/definitions/LocationInfo"
        },
        "length":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : IVariableItem

Type: object

Show Source

• editable(optional): boolean
• expressionString(optional): string
• name(optional): string
• namespaceMapping(optional): object namespaceMapping
  Additional Properties Allowed: additionalProperties
• type(optional): object QName
• value(optional): string

{
    "type":"object",
    "properties":{
        "namespaceMapping":{
            "type":"object",
            "additionalProperties":{
                "type":"string",
                "format":"uri"
            }
        },
        "expressionString":{
            "type":"string"
        },
        "editable":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "type":{
            "$ref":"#/definitions/QName"
        }
    }
}

Nested Schema : namespaceMapping

Type: object

Additional Properties Allowed

Show Source

• string(uri)

{
    "type":"object",
    "additionalProperties":{
        "type":"string",
        "format":"uri"
    }
}

Nested Schema : IActivityInfo

Type: object

Show Source

• displayName(optional): string
• id(optional): string
• processId(optional): string

{
    "type":"object",
    "properties":{
        "processId":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        }
    }
}

Nested Schema : IProcessInstanceInfo

Type: object

Show Source

• id(optional): integer(int64)
• thread(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "thread":{
            "type":"integer",
            "format":"int32"
        },
        "id":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : LocationInfo

Type: object

Show Source

• absoluteScopeId(optional): string
• activityInfo(optional): object IActivityInfo
• loopCounter(optional): object loopCounter
• multiInstance(optional): boolean
• processInstanceInfo(optional): object ProcessInstanceInfo
• root(optional): boolean

{
    "type":"object",
    "properties":{
        "absoluteScopeId":{
            "type":"string"
        },
        "activityInfo":{
            "$ref":"#/definitions/IActivityInfo"
        },
        "multiInstance":{
            "type":"boolean"
        },
        "loopCounter":{
            "type":"object"
        },
        "processInstanceInfo":{
            "$ref":"#/definitions/ProcessInstanceInfo"
        },
        "root":{
            "type":"boolean"
        }
    }
}

Nested Schema : IterableILocationInfo

Type: object

Nested Schema : loopCounter

Type: object

Nested Schema : ProcessInstanceInfo

Type: object

Show Source

• id(optional): integer(int64)
• thread(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "thread":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : ActivityInfo

Type: object

Show Source

• displayName(optional): string
• id(optional): string
• processId(optional): string

{
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "processId":{
            "type":"string"
        }
    }
}

400 Response

Bad Request.

401 Response

Unauthorized

404 Response

Not Found

500 Response

Internal Server Error

Back to Top

Examples

The following example shows how to retrieve data objects for a process instance at the process level by submitting a GET request on the REST resource:

Send Request

https://example.com/ic/api/process/v1/processes/{processId}/dataobjects

where

• example.com is the host where Oracle Integration is running.

• <version> is the REST API version.

• <Process ID> is the ID of the process.

  For example, 1. You can get the <Process ID> using Retrieves Process Instance List.

Example of Response Header

Status Code: 200 OK

Example of Response Body

{
   "dataVariableNodesFlatRes": [
        {
            "levels": 0,
            "editable": true,
            "name": "startWebFormDataObject",
            "nodeType": "NODE_TYPE_VARIABLE",
            "scope": "MainProcess",
            "value": "{ \"travelPurpose\" : \"tsss\" , \"cost\" : \"134\" }"
        },
        {
            "levels": 0,
            "editable": true,
            "name": "TaskOutcomeDataObject",
            "nodeType": "NODE_TYPE_VARIABLE",
            "scope": "MainProcess"
        },
        {
            "levels": 0,
            "editable": false,
            "name": "ownerType",
            "nodeType": "NODE_TYPE_INSTANCE_ATTRIBUTE",
            "scope": "MainProcess",
            "value": "ROLE"
        },
    ]
}

Back to Top