Jump to

• Request
• Response

Retrieve a Process Instance

get

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

Retrieves a process instance If document store is enabled for a particular instance apis to fetch and upload attachments will return a error message stating 'Document store is enabled attachments can not be used'. If document store is not enabled for a particular instance apis to fetch folders will return an error message stating 'Document store is not configured'. If conversations are not enabled for a particular instance apis to fetch conversation details will return error message stating 'Conversation are not enabled'

Request

Path Parameters

• processId(required): string
  Value of process ID.

Query Parameters

• isProcessNumberFlag: boolean
  Value of processNumber, if true it will fetch process instance by number, if false it will return process instance by instanceId

  Default Value: false

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root 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"
        }
    }
}

500 Response

Internal Server Error

Back to Top