Jump to

• Request
• Response

Retrieve Process Definitions

get

/ic/api/process/v1/process-definitions

Retrieves process definitions.

Request

Query Parameters

• filterDefaultVersion: string
  True to fetch only default process definition versions else false

  Default Value: false
• interfaceFilter: string
  Retrieves those with forms, without, or both - form, noForm, doc, folder or all

  Default Value: all
• processDefId: string
  Process Definition Id to filter the results on
• showProcessInstancesCount: string
  True to get processcount else false

  Default Value: false

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : processDefs

Type: object

Show Source

• items: array items
• levels: integer(int32)
• links: array links
• 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"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AbstractProcessDef"
            }
        }
    },
    "xml":{
        "name":"processDefs",
        "namespace":"http://xmlns.oracle.com/bpm/rest/processdef"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object AbstractProcessDef

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : AbstractProcessDef

Type: object

Show Source

• application: string
• category: string
• defaultVersion: boolean
• domain: string
• interfaces: array interfaces
• isConversationEnabledFlag: boolean
• isDocsEnabledFlag: boolean
• processCount: integer(int32)
• processDefId: string
• processIcon: object ProcessIcon
• processName: string
• revision: string

{
    "type":"object",
    "properties":{
        "processDefId":{
            "type":"string"
        },
        "processName":{
            "type":"string"
        },
        "application":{
            "type":"string"
        },
        "revision":{
            "type":"string"
        },
        "domain":{
            "type":"string"
        },
        "interfaces":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Interface"
            }
        },
        "processIcon":{
            "$ref":"#/definitions/ProcessIcon"
        },
        "processCount":{
            "type":"integer",
            "format":"int32"
        },
        "isDocsEnabledFlag":{
            "type":"boolean"
        },
        "isConversationEnabledFlag":{
            "type":"boolean"
        },
        "category":{
            "type":"string"
        },
        "defaultVersion":{
            "type":"boolean"
        }
    }
}

Nested Schema : interfaces

Type: array

Show Source

• Array of: object Interface

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

Nested Schema : ProcessIcon

Type: object

Show Source

• colorCode: string
• initials: string

{
    "type":"object",
    "properties":{
        "initials":{
            "type":"string"
        },
        "colorCode":{
            "type":"string"
        }
    }
}

Nested Schema : Interface

Type: object

Show Source

• args: array args
• category: string
• description: string
• formMetadata: string
• operation: string
• operationNameSpace: string
• serviceName: string
• startType: string
• title: string

{
    "type":"object",
    "properties":{
        "title":{
            "type":"string"
        },
        "serviceName":{
            "type":"string"
        },
        "operation":{
            "type":"string"
        },
        "operationNameSpace":{
            "type":"string"
        },
        "startType":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Arg"
            }
        },
        "formMetadata":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object Arg

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

Nested Schema : Arg

Type: object

Show Source

• name: string
• primitive: boolean
• schema: object schema
  Additional Properties Allowed: additionalProperties
• type: object QName

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "$ref":"#/definitions/QName"
        },
        "schema":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "primitive":{
            "type":"boolean"
        }
    }
}

Nested Schema : schema

Type: object

Additional Properties Allowed

Show Source

• string

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

Nested Schema : QName

Type: object

Show Source

• localPart: string
• namespaceURI: string
• prefix: string

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

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

Error in retrieving the process definitions

Back to Top