Jump to

• Request
• Response
• Examples

Delete All Versions of an Application

delete

/process/api/v1/design/dmnApplications/{applicationName}

Delete an application including all its versions and snapshots. Deactivate the application before you delete it.

Request

Path Parameters

• applicationName(required): string
  Application name

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Application deleted

Body ()

Root Schema : Applications

Type: object

Show Source

• count: number
• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Application"
            }
        },
        "count":{
            "type":"number"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Application

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Application"
    }
}

Nested Schema : Application

Type: object

Show Source

• activation: object Activation
• assets: array assets
• audit: object Audit
• description: string
• id: string (uuid)
• name: string
• snapshots: array snapshots
• title: string
• version: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "audit":{
            "$ref":"#/components/schemas/Audit"
        },
        "assets":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Assets"
            }
        },
        "snapshots":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Snapshots"
            }
        },
        "activation":{
            "$ref":"#/components/schemas/Activation"
        }
    }
}

Nested Schema : Activation

Type: object

Show Source

• audit: object Audit
• id: string (uuid)
• isDefault: boolean
• snapshotId: string (uuid)
• snapshotName: string
• status: string
  Allowed Values: [ "ACTIVATION_STARTED", "ACTIVATING", "ACTIVATED", "ACTIVATION_FAILED", "DEACTIVATING", "DEACTIVATED", "DEACTIVATION_FAILED" ]

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "snapshotId":{
            "type":"string",
            "format":"uuid"
        },
        "snapshotName":{
            "type":"string"
        },
        "isDefault":{
            "type":"boolean"
        },
        "audit":{
            "$ref":"#/components/schemas/Audit"
        },
        "status":{
            "type":"string",
            "enum":[
                "ACTIVATION_STARTED",
                "ACTIVATING",
                "ACTIVATED",
                "ACTIVATION_FAILED",
                "DEACTIVATING",
                "DEACTIVATED",
                "DEACTIVATION_FAILED"
            ]
        }
    }
}

Nested Schema : assets

Type: array

Show Source

• Array of: object Assets

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Assets"
    }
}

Nested Schema : Audit

Type: object

Show Source

• createdBy: string
• createdOn: string (date-time)

{
    "type":"object",
    "properties":{
        "createdBy":{
            "type":"string"
        },
        "createdOn":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : snapshots

Type: array

Show Source

• Array of: object Snapshots

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Snapshots"
    }
}

Nested Schema : Assets

Type: object

Show Source

• id: string (uuid)
• name: string
• type: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : Snapshots

Type: object

Show Source

• count: number
• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Snapshot"
            }
        },
        "count":{
            "type":"number"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Snapshot

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Snapshot"
    }
}

Nested Schema : Snapshot

Type: object

Show Source

• audit: object Audit
• description: string
• id: string (uuid)
• name: string
• status: string
  Allowed Values: [ "IN_PROGRESS", "SUCCESSFUL", "FAILED" ]
• validation: string
  Allowed Values: [ "IN_PROGRESS", "SUCCESSFUL", "SUCCESSFUL_WITH_WARNINGS", "FAILED" ]

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "audit":{
            "$ref":"#/components/schemas/Audit"
        },
        "status":{
            "type":"string",
            "enum":[
                "IN_PROGRESS",
                "SUCCESSFUL",
                "FAILED"
            ]
        },
        "validation":{
            "type":"string",
            "enum":[
                "IN_PROGRESS",
                "SUCCESSFUL",
                "SUCCESSFUL_WITH_WARNINGS",
                "FAILED"
            ]
        }
    }
}

401 Response

Unauthorized

404 Response

Application not found.

409 Response

Application must be deactivated before it can be deleted.

500 Response

An internal error occurred.

Back to Top

Examples

The following example shows how to delete all versions of a decision application by submitting a DELETE request on the REST resource using cURL. For more information about cURL, see cURL Access. For more information about endpoint URL structure, see Send Requests.

Example: cURL command to delete all versions of application Invoicing

curl -X 'DELETE' \
  'https://<URL>/decision/api/v1/design/dmnApplications/Invoicing' \
  -H 'accept: application/json'

Example: Response body of 200 successful response in JSON format

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "version": "string",
      "title": "string",
      "description": "string",
      "audit": {
        "createdBy": "string",
        "createdOn": "2024-06-13T16:14:13.581Z"
      },
      "assets": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string",
          "type": "string"
        }
      ],
      "snapshots": [
        {
          "items": [
            {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "name": "string",
              "description": "string",
              "audit": {
                "createdBy": "string",
                "createdOn": "2024-06-13T16:14:13.581Z"
              },
              "status": "IN_PROGRESS",
              "validation": "IN_PROGRESS"
            }
          ],
          "count": 0
        }
      ],
      "activation": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "snapshotName": "string",
        "isDefault": true,
        "audit": {
          "createdBy": "string",
          "createdOn": "2024-06-13T16:14:13.581Z"
        },
        "status": "ACTIVATION_STARTED"
      }
    }
  ],
  "count": 0
}

Back to Top