Jump to

• Request
• Response
• Examples

Perform Actions on a List of Instances

put

/ic/api/process/v1/processes

Performs actions on instance list

Request

Body ()

value of process IDs and update states

Root Schema : action

Type: object

Show Source

• abortType(optional): string
• activityChanges(optional): array activityChanges
• assignees(optional): array assignees
• comments(optional): string
• correlationKeyChanges(optional): array correlationKeyChanges
• dataObjectChanges(optional): array dataObjectChanges
• faultActionType(optional): string
• flowId(optional): integer(int64)
• id(optional): string
• instanceAttributeChanges(optional): array instanceAttributeChanges
• processes(optional): array processes
• type(optional): string

{
    "type":"object",
    "properties":{
        "assignees":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Identity"
            }
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "processes":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "faultActionType":{
            "type":"string"
        },
        "flowId":{
            "type":"integer",
            "format":"int64"
        },
        "abortType":{
            "type":"string"
        },
        "comments":{
            "type":"string"
        },
        "activityChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FlowChangeItemReq"
            }
        },
        "dataObjectChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        },
        "instanceAttributeChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        },
        "correlationKeyChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        }
    },
    "xml":{
        "name":"action",
        "namespace":"http://xmlns.oracle.com/bpm/rest/processdef"
    }
}

Nested Schema : activityChanges

Type: array

Show Source

• Array of: object FlowChangeItemReq

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

Nested Schema : assignees

Type: array

Show Source

• Array of: object identity
  Discriminator: type

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

Nested Schema : correlationKeyChanges

Type: array

Show Source

• Array of: object DataVariable

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

Nested Schema : dataObjectChanges

Type: array

Show Source

• Array of: object DataVariable

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

Nested Schema : instanceAttributeChanges

Type: array

Show Source

• Array of: object DataVariable

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

Nested Schema : processes

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : FlowChangeItemReq

Type: object

Show Source

• correlationKeyChanges(optional): array correlationKeyChanges
• dataObjectChanges(optional): array dataObjectChanges
• instanceAttributeChanges(optional): array instanceAttributeChanges
• sourceActivityId(optional): string
• targetActivityId(optional): string

{
    "type":"object",
    "properties":{
        "sourceActivityId":{
            "type":"string"
        },
        "targetActivityId":{
            "type":"string"
        },
        "dataObjectChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        },
        "instanceAttributeChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        },
        "correlationKeyChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        }
    }
}

Nested Schema : correlationKeyChanges

Type: array

Show Source

• Array of: object DataVariable

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

Nested Schema : dataObjectChanges

Type: array

Show Source

• Array of: object DataVariable

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

Nested Schema : instanceAttributeChanges

Type: array

Show Source

• Array of: object DataVariable

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

Nested Schema : DataVariable

Type: object

Show Source

• correlationKeyPropertyName(optional): object QName
• name(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "correlationKeyPropertyName":{
            "$ref":"#/definitions/QName"
        }
    }
}

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 : identity

Type: object

Discriminator: type

Show Source

• id(optional): string
• identity(optional): object Link
• levels(optional): integer(int32)
• links(optional): array links
• title(optional): string
• type(optional): string

{
    "type":"object",
    "discriminator":"type",
    "properties":{
        "levels":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        },
        "links":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"links"
                },
                "$ref":"#/definitions/Link"
            }
        },
        "title":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "identity":{
            "$ref":"#/definitions/Link"
        }
    },
    "xml":{
        "name":"identity",
        "namespace":"http://xmlns.oracle.com/bpm/rest/identities"
    }
}

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 : links

Type: array

Show Source

• Array of: object Link

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

Back to Top

Response

Supported Media Types

• application/json
• text/plain

200 Response

Success

304 Response

Not Modified

403 Response

Forbidden

500 Response

Internal Server Error

Back to Top

Examples

The following example shows how to perform actions on a list of process instance by submitting a PUT request on the REST resource.

Currently, the only action supported is recoverFaultedInstances.

Send Request

https://example.com/ic/api/process/<version>/processes

Where,

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

• <version> is the REST API version.

Example of Request Body

{
 "processes":["3","5"],
"id":"recoverFaultedInstances"
}

Example of Response Header

Status Code: 200 OK
Date: Wed, 27 Apr 2016 00:53:16 GMT
Content-Type: application/json

Example of Response Body

Processes recovered successfully

Back to Top