Jump to

• Request
• Response

Get a List of Dynamic Process Instances

get

/ic/api/process/v1/dp-instances

Get a list of dynamic process instances that the user can access.

Request

Supported Media Types

• application/json

Query Parameters

• childProcessInstanceId: string
  Restrict query to one dynamic process instance that has a sub process instance with the specified ID.
• closedAfter: string
  Restrict to instances that were closed after the specified date. The date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ. For example, 2013-01-23T14:42:45.000Z for UTC timezone.
• closedBefore: string
  Restrict to dynamic process instances that were closed before the specified date. The date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ. For example, 2013-01-23T14:42:45.000Z for UTC timezone.
• createdAfter: string
  Restrict to dynamic process instances that were created after the specified date. The date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ. For exmple, 2013-01-23T14:42:45.000Z for UTC timezone.
• createdBefore: string
  Restrict to dynamic process instances that were created before the specified date. The date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ. For example, 2013-01-23T14:42:45.000Z for UTC timezone.
• firstResult: integer
  Pagination of results. Specifies the index of the first result to return.
• instanceId: string
  Filter by dynamic process instance ID.
• instanceIdIn: array[string]
  Collection Format: multi

  Filter by dynamic process instance IDs in the array.
• maxResults: integer
  Pagination of results. Specifies the maximum number of results to return. Will return fewer results if there are no more results left.
• parentProcessInstanceId: string
  Restrict query to all dynamic process instances that are sub process instances of the specified process instance. Specify a dynamic process instance ID.
• processDefinitionId: string
  Filter by dynamic process definition ID. Exact match.
• processDefinitionKey: string
  Filter by dynamic process definition key. Exact match
• processDefinitionKeyNotIn: array[string]
  Collection Format: multi

  Exclude instances that belong to a set of dynamic process definitions. Must be a comma-separated list of process definition keys.
• processDefinitionName: string
  Filter by the name of the dynamic process definition the instances run on.
• processDefinitionNameLike: string
  Filter by the dynamic process definition names that the parameter is a substring of. The string can include the wildcard character '%' to express like-strategy. For example, starts with (string%), ends with (%string) or contains (%string%).
• sortBy: string
  Sort the results by the specified criteria. Valid values are: instanceId, definitionId, createTime, closeTime, duration. Must be used in conjunction with the sortOrder parameter.
• sortOrder: string
  Sort the results in a specified order. Values are asc for ascending order, or desc for descending order. Must be used in conjunction with the sortBy parameter.
• state: string
  Restrict query to all dynamic process instances that are in a specified state.
• updatedBy: string
  Only include dynamic process instances that were updated by the specified user.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ProcessInstances

Type: object

Match All

Show Source

• object CommonModel
  Discriminator: links
• object ProcessInstances-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CommonModel"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ProcessInstance"
                    }
                }
            }
        }
    ]
}

Nested Schema : CommonModel

Type: object

Discriminator: links

Show Source

• links: array links

{
    "type":"object",
    "discriminator":"links",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : ProcessInstances-allOf[1]

Type: object

Show Source

• items: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object processInstance

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

Nested Schema : processInstance

Type: object

Show Source

• conversationId: string
• createdBy: string
• createdDate: string
• dueDate: string
• expirationDate: string
• href: string(uri)
• isConversationEnabledFlag: boolean
• isDocsEnabledFlag: boolean
• levels: integer(int32)
• links: array links
• ownedBy: string
• priority: integer(int32)
• processDefId: string
• processDN: string
• processId: string
• processName: string
• processNumber: integer(int32)
• state: string
• title: 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"
        },
        "processId":{
            "type":"string"
        },
        "processDefId":{
            "type":"string"
        },
        "processName":{
            "type":"string"
        },
        "priority":{
            "type":"integer",
            "format":"int32"
        },
        "ownedBy":{
            "type":"string",
            "xml":{
                "name":"owner"
            }
        },
        "createdBy":{
            "type":"string",
            "xml":{
                "name":"creator"
            }
        },
        "conversationId":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "expirationDate":{
            "type":"string"
        },
        "dueDate":{
            "type":"string"
        },
        "processDN":{
            "type":"string"
        },
        "processNumber":{
            "type":"integer",
            "format":"int32"
        },
        "href":{
            "type":"string",
            "format":"uri"
        },
        "isDocsEnabledFlag":{
            "type":"boolean"
        },
        "isConversationEnabledFlag":{
            "type":"boolean"
        }
    },
    "xml":{
        "name":"processInstance",
        "namespace":"http://xmlns.oracle.com/bpm/rest/processdef"
    }
}

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: string
• mediaType: string
• rel: string

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

400 Response

Returned if some of the query parameters are not valid. For example, if a sortOrder parameter is supplied, but no sortBy.

401 Response

Unauthorized

500 Response

Internal Server Error

Back to Top