Jump to

• Request
• Response

List Applications by Name

get

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

Show all the applications available by name.

Request

Path Parameters

• applicationName(required): string
  Application name

Query Parameters

• expand:
  Expand resources

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

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.

500 Response

An internal error occurred.

Back to Top