Jump to

• Request
• Response
• Examples

Create or Import an Application

post

/process/api/v1/design/dmnApplications

Create an empty application or import an application from an dmnx file.

Request

There are no request parameters for this operation.

Supported Media Types

• multipart/form-data

Request Body - multipart/form-data ()

Root Schema : schema

Type: object

Show Source

• file: string (binary)
  Choose application dmnx file to import
• json(required): object CreateApplicationRequest
  Request body for application creation/import

{
    "required":[
        "json"
    ],
    "type":"object",
    "properties":{
        "json":{
            "$ref":"#/components/schemas/CreateApplicationRequest"
        },
        "file":{
            "type":"string",
            "format":"binary",
            "description":"Choose application dmnx file to import"
        }
    }
}

Nested Schema : CreateApplicationRequest

Type: object

Request body for application creation/import

Show Source

• description: string
  Default Value:

  Description for new application
• forceFlag: boolean
  Default Value: false

  Force deletion of previous application (if exist)
• name(required): string
  name for new application
• title(required): string
  title for new application
• version(required): string
  version for new application

{
    "type":"object",
    "description":"Request body for application creation/import",
    "required":[
        "name",
        "version",
        "title"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"name for new application"
        },
        "version":{
            "type":"string",
            "description":"version for new application"
        },
        "title":{
            "type":"string",
            "description":"title for new application"
        },
        "description":{
            "type":"string",
            "description":"Description for new application",
            "default":""
        },
        "forceFlag":{
            "type":"boolean",
            "description":"Force deletion of previous application (if exist)",
            "default":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Application created

Body ()

Root 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

405 Response

Application expx file cannot be imported.

409 Response

Application already exists. Delete it manually or by enabling 'forceFlag'.

500 Response

An internal error occurred.

Back to Top

Examples

The following example shows how to create or import an empty decision application by submitting a POST 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: JSON Request body for application creation/import

{
  "name": "string",
  "version": "string",
  "title": "string",
  "description": "",
  "forceFlag": false
}

Example: cURL command to create or import an empty application

curl -X 'POST' \
  'https://oracle.com/decision/api/v1/design/dmnApplications' \
  -H 'accept: application/json' \
  -H 'Content-Type: multipart/form-data' \
  -F 'json={"name":"string","version":"string","title":"string","description":"","forceFlag":false}' \
  -F 'file='

Example: Response body of 201 successful response in JSON format

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "version": "string",
  "title": "string",
  "description": "string",
  "audit": {
    "createdBy": "string",
    "createdOn": "2024-06-13T15:57:45.582Z"
  },
  "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-13T15:57:45.582Z"
          },
          "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-13T15:57:45.582Z"
    },
    "status": "ACTIVATION_STARTED"
  }
}

Back to Top