Jump to

• Request
• Response
• Examples

Activate an Application

put

/process/api/v1/design/dmnApplications/{applicationName}/versions/{version}/activate

Activate an application from a snapshot.

Request

Path Parameters

• applicationName(required): string
  Application name
• version(required): string
  Application version

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request body for activation

Show Source

• defaultFlag: boolean
  Default Value: false

  Default flag option
• snapshotId(required): string (uuid)
  Snapshot ID

{
    "type":"object",
    "description":"Request body for activation",
    "required":[
        "snapshotId"
    ],
    "properties":{
        "snapshotId":{
            "type":"string",
            "description":"Snapshot ID",
            "format":"uuid"
        },
        "defaultFlag":{
            "type":"boolean",
            "description":"Default flag option",
            "default":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Successfully started application activation

Body ()

Root 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 : Audit

Type: object

Show Source

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

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

401 Response

Unauthorized

404 Response

Application not found.

409 Response

Application already activated.

500 Response

An internal error occurred.

Back to Top

Examples

The following example shows how to activate a decision application from a snapshot by submitting a PUT 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 activate application Invoicing version 1 and snapshot id 3fa85f64-63f66afa6

curl -X 'PUT' \
  'https://<URL>/decision/api/v1/design/dmnApplications/invoicing/versions/1/activate' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "snapshotId": "3fa85f64-63f66afa6",
  "defaultFlag": false
}'

Example: Response body of 202 successful response in JSON format

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "snapshotId": "3fa85f64-63f66afa6",
  "snapshotName": "string",
  "isDefault": true,
  "audit": {
    "createdBy": "string",
    "createdOn": "2023-06-13T15:00:48.120Z"
  },
  "status": "ACTIVATION_STARTED"
}

Back to Top