{
  "opencollection": "1.0.0",
  "info": {
    "name": "Flowable REST Access Tokens Case Instances API",
    "version": "v1"
  },
  "items": [
    {
      "info": {
        "name": "Case Instances",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Query case instances",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/flowable-rest/service/cmmn-query/case-instances",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "The request body can contain all possible filters that can be used in the List case instances URL query. On top of these, it’s possible to provide an array of variables to include in the query, with their format described here.\n\nThe general paging and sorting query-parameters can be used for this URL."
        },
        {
          "info": {
            "name": "List case instances",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/flowable-rest/service/cmmn-runtime/case-instances",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "Only return case instances with the given id."
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "Only return case instances with the given comma-separated ids."
              },
              {
                "name": "caseDefinitionKey",
                "value": "",
                "type": "query",
                "description": "Only return case instances with the given case definition key."
              },
              {
                "name": "caseDefinitionKeyLike",
                "value": "",
                "type": "query",
                "description": "Only return case instances like given case definition key."
              },
              {
                "name": "caseDefinitionKeyLikeIgnoreCase",
                "value": "",
                "type": "query",
                "description": "Only return case instances like given case definition key, ignoring case."
              },
              {
                "name": "caseDefinitionId",
                "value": "",
                "type": "query",
                "description": "Only return case instances with the given case definition id."
              },
              {
                "name": "caseDefinitionCategory",
                "value": "",
                "type": "query",
                "description": "Only return case instances with the given case definition category."
              },
              {
                "name": "caseDefinitionCategoryLike",
                "value": "",
                "type": "query",
                "description": "Only return case instances like the given case definition category."
              },
              {
                "name": "caseDefinitionCategoryLikeIgnoreCase",
                "value": "",
                "type": "query",
                "description": "Only return case instances like the given case definition category, ignoring case."
              },
              {
                "name": "caseDefinitionName",
                "value": "",
                "type": "query",
                "description": "Only return case instances with the given case definition name."
              },
              {
                "name": "caseDefinitionNameLike",
                "value": "",
                "type": "query",
                "description": "Only return case instances like the given case definition name."
              },
              {
                "name": "caseDefinitionNameLikeIgnoreCase",
                "value": "",
                "type": "query",
                "description": "Only return case instances like the given case definition name, ignoring case."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Only return case instances with the given name."
              },
              {
                "name": "nameLike",
                "value": "",
                "type": "query",
                "description": "Only return case instances like the given name."
              },
              {
                "name": "nameLikeIgnoreCase",
                "value": "",
                "type": "query",
                "description": "Only return case instances like the given name ignoring case."
              },
              {
                "name": "rootScopeId",
                "value": "",
                "type": "query",
                "description": "Only return case instances which have the given root scope id (that can be a process or case instance ID)."
              },
              {
                "name": "parentScopeId",
                "value": "",
                "type": "query",
                "description": "Only return case instances which have the given parent scope id (that can be a process or case instance ID)."
              },
              {
                "name": "businessKey",
                "value": "",
                "type": "query",
                "description": "Only return case instances with the given business key."
              },
              {
                "name": "businessKeyLike",
                "value": "",
                "type": "query",
                "description": "Only return case instances like the given business key."
              },
              {
                "name": "businessKeyLikeIgnoreCase",
                "value": "",
                "type": "query",
                "description": "Only return case instances like the given business key, ignoring case."
              },
              {
                "name": "businessStatus",
                "value": "",
                "type": "query",
                "description": "Only return case instances with the given business status."
              },
              {
                "name": "businessStatusLike",
                "value": "",
                "type": "query",
                "description": "Only return case instances like the given business status."
              },
              {
                "name": "businessStatusLikeIgnoreCase",
                "value": "",
                "type": "query",
                "description": "Only return case instances like the given business status, ignoring case."
              },
              {
                "name": "caseInstanceParentId",
                "value": "",
                "type": "query",
                "description": "Only return case instances with the given parent id."
              },
              {
                "name": "startedBy",
                "value": "",
                "type": "query",
                "description": "Only return case instances started by the given user."
              },
              {
                "name": "startedBefore",
                "value": "",
                "type": "query",
                "description": "Only return case instances started before the given date."
              },
              {
                "name": "startedAfter",
                "value": "",
                "type": "query",
                "description": "Only return case instances started after the given date."
              },
              {
                "name": "state",
                "value": "",
                "type": "query",
                "description": "Only return case instances with the given state."
              },
              {
                "name": "callbackId",
                "value": "",
                "type": "query",
                "description": "Only return case instances which have the given callback id."
              },
              {
                "name": "callbackIds",
                "value": "",
                "type": "query",
                "description": "Only return case instances which have the given callback ids."
              },
              {
                "name": "callbackType",
                "value": "",
                "type": "query",
                "description": "Only return case instances which have the given callback type."
              },
              {
                "name": "parentCaseInstanceId",
                "value": "",
                "type": "query",
                "description": "Only return case instances which have the given parent case instance id."
              },
              {
                "name": "referenceId",
                "value": "",
                "type": "query",
                "description": "Only return case instances which have the given reference id."
              },
              {
                "name": "referenceType",
                "value": "",
                "type": "query",
                "description": "Only return case instances which have the given reference type."
              },
              {
                "name": "lastReactivatedBy",
                "value": "",
                "type": "query",
                "description": "Only return case instances last reactivated by the given user."
              },
              {
                "name": "lastReactivatedBefore",
                "value": "",
                "type": "query",
                "description": "Only return case instances last reactivated before the given date."
              },
              {
                "name": "lastReactivatedAfter",
                "value": "",
                "type": "query",
                "description": "Only return case instances last reactivated after the given date."
              },
              {
                "name": "includeCaseVariables",
                "value": "",
                "type": "query",
                "description": "Indication to include case variables in the result."
              },
              {
                "name": "includeCaseVariablesName",
                "value": "",
                "type": "query",
                "description": "Indication to include case variables with the given names in the result."
              },
              {
                "name": "activePlanItemDefinitionId",
                "value": "",
                "type": "query",
                "description": "Only return case instances that have an active plan item instance with the given plan item definition id."
              },
              {
                "name": "tenantId",
                "value": "",
                "type": "query",
                "description": "Only return case instances with the given tenantId."
              },
              {
                "name": "tenantIdLike",
                "value": "",
                "type": "query",
                "description": "Only return case instances with a tenantId like the given value."
              },
              {
                "name": "tenantIdLikeIgnoreCase",
                "value": "",
                "type": "query",
                "description": "Only return case instances with a tenantId like the given value, ignoring case."
              },
              {
                "name": "withoutTenantId",
                "value": "",
                "type": "query",
                "description": "If true, only returns case instances without a tenantId set. If false, the withoutTenantId parameter is ignored."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Property to sort on, to be used together with the order."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "List case instances"
        },
        {
          "info": {
            "name": "Start a case instance",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/flowable-rest/service/cmmn-runtime/case-instances",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Note that also a *transientVariables* property is accepted as part of this json, that follows the same structure as the *variables* property.\n\nOnly one of *caseDefinitionId* or *caseDefinitionKey* an be used in the request body.\n\nParameters *businessKey*, *variables* and *tenantId* are optional.\n\nIf tenantId is omitted, the default tenant will be used.\n\n It is possible to send variables, transientVariables and startFormVariables in one request.\n\nMore information about the variable format can be "
        },
        {
          "info": {
            "name": "Post action request to delete/terminate a bulk of case instances",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/flowable-rest/service/cmmn-runtime/case-instances/delete",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Post action request to delete/terminate a bulk of case instances"
        },
        {
          "info": {
            "name": "Get a case instance",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/flowable-rest/service/cmmn-runtime/case-instances/:caseInstanceId",
            "params": [
              {
                "name": "caseInstanceId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get a case instance"
        },
        {
          "info": {
            "name": "Update case instance properties or execute an action on a case instance (body needs to contain an 'action' property for the latter).",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/flowable-rest/service/cmmn-runtime/case-instances/:caseInstanceId",
            "params": [
              {
                "name": "caseInstanceId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Update case instance properties or execute an action on a case instance (body needs to contain an 'action' property for the latter)."
        },
        {
          "info": {
            "name": "Terminate a case instance",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/flowable-rest/service/cmmn-runtime/case-instances/:caseInstanceId",
            "params": [
              {
                "name": "caseInstanceId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Terminate a case instance"
        },
        {
          "info": {
            "name": "Change the state of a case instance",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/flowable-rest/service/cmmn-runtime/case-instances/:caseInstanceId/change-state",
            "params": [
              {
                "name": "caseInstanceId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Change the state of a case instance"
        },
        {
          "info": {
            "name": "Delete a case instance",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/flowable-rest/service/cmmn-runtime/case-instances/:caseInstanceId/delete",
            "params": [
              {
                "name": "caseInstanceId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Delete a case instance"
        },
        {
          "info": {
            "name": "Get diagram for a case instance",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/flowable-rest/service/cmmn-runtime/case-instances/:caseInstanceId/diagram",
            "params": [
              {
                "name": "caseInstanceId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get diagram for a case instance"
        },
        {
          "info": {
            "name": "Migrate case instance",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/flowable-rest/service/cmmn-runtime/case-instances/:caseInstanceId/migrate",
            "params": [
              {
                "name": "caseInstanceId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Migrate case instance"
        },
        {
          "info": {
            "name": "getStageOverview",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/flowable-rest/service/cmmn-runtime/case-instances/:caseInstanceId/stage-overview",
            "params": [
              {
                "name": "caseInstanceId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          }
        }
      ]
    }
  ],
  "bundled": true
}