Jump to

• Request
• Response

Deactivate an Application

put

/process/api/v1/design/applications/{applicationName}/versions/{version}/deactivate

Deactivate an application by name and version.

Request

Path Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Application deactivated

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"
        }
    }
}

202 Response

Successfully started application deactivation

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.

500 Response

An internal error occurred.

Back to Top