Qodex.ai

Get executable process models

GET {{baseUrl}}/runtime/models?version=-98125607&name=voluptate elit&nameLike=voluptate elit&key=voluptate elit&keyLike=voluptate elit&category=voluptate elit&categoryLike=voluptate elit&categoryNotEquals=voluptate elit&deploymentId=voluptate elit&latestVersion=true&filterByCurrentSubscription=true&deploymentSpace=voluptate elit&offset=voluptate elit&count=voluptate elit&sort=key

Get the executable process models across all deployed versions.

Request Params

KeyDatatypeRequiredDescription
versionnumberOnly return process definitions with the given version.
namestringOnly return process definitions with the given name.
nameLikestringOnly return process definitions with a name like the given name.
keystringOnly return process definitions with the given key.
keyLikestringOnly return process definitions with a name like the given key.
categorystringOnly return process definitions with the given category.
categoryLikestringOnly return process definitions with a category like the given name.
categoryNotEqualsstringOnly return process definitions which do not have the given category.
deploymentIdstringOnly return process definitions with the given deployment id.
latestVersionbooleanOnly return the latest process definition versions
filterByCurrentSubscriptionbooleanOnly return the process definitions in the current subscription
deploymentSpacestringOnly return the process definitions with the given deployment space.
offsetstringStart position value in the list of items, used for pagination.
countstringNumber of items to be limited in the response, used for pagination. By default the count value is set to 10.
sortstringProperty to sort on, to be used together with the order.

RESPONSES

status: OK

{"content":[[{"category":"Sample category","deploymentSpace":"TENANT","id":"034eedd5-3209-11ea-ad13-eeee0aff6857","key":"SampleKey","links":{"empty":true},"name":"Sample Process","processDefinitionId":"SampleKey:1:034eedd5-3209-11ea-ad13-eeee0aff6857","subscriptionId":"cda90802-4bcc-4134-9815-95b8ed50b516","tenantId":"cda90802-4bcc-4134-9815-95b8ed50b516","version":1},{"category":"Sample category","deploymentSpace":"TENANT","id":"034eedd5-3209-11ea-ad13-eeee0aff6857","key":"SampleKey","links":{"empty":false},"name":"Sample Process","processDefinitionId":"SampleKey:1:034eedd5-3209-11ea-ad13-eeee0aff6857","subscriptionId":"cda90802-4bcc-4134-9815-95b8ed50b516","tenantId":"cda90802-4bcc-4134-9815-95b8ed50b516","version":1}],[{"category":"Sample category","deploymentSpace":"TENANT","id":"034eedd5-3209-11ea-ad13-eeee0aff6857","key":"SampleKey","links":{"empty":false},"name":"Sample Process","processDefinitionId":"SampleKey:1:034eedd5-3209-11ea-ad13-eeee0aff6857","subscriptionId":"cda90802-4bcc-4134-9815-95b8ed50b516","tenantId":"cda90802-4bcc-4134-9815-95b8ed50b516","version":1},{"category":"Sample category","deploymentSpace":"TENANT","id":"034eedd5-3209-11ea-ad13-eeee0aff6857","key":"SampleKey","links":{"empty":true},"name":"Sample Process","processDefinitionId":"SampleKey:1:034eedd5-3209-11ea-ad13-eeee0aff6857","subscriptionId":"cda90802-4bcc-4134-9815-95b8ed50b516","tenantId":"cda90802-4bcc-4134-9815-95b8ed50b516","version":1}]],"links":{"empty":false}}