Jump to

• Request
• Response
• Examples

Create a Snapshot

post

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

Creates a new snapshot from the latest changes.

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 snapshot creation

Show Source

• description: string
  Default Value:

  Description for new application
• name(required): string
  name for new application

{
    "type":"object",
    "description":"Request body for snapshot creation",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"name for new application"
        },
        "description":{
            "type":"string",
            "description":"Description for new application",
            "default":""
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Snapshot created

Body ()

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

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

Examples

The following example shows how to create a snapshot from the latest changes 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.

Snapshot request body

{
  "name": "Snapshot X",
  "description": "new snapshot"
}

Example: cURL command to create a snapshot of application Invoicing version 1

curl -X 'POST' \
      'https://oracle.com/decision/api/v1/design/dmnApplications/Invoicing/versions/1/snapshots'
      \   -H 'accept: application/json' \   -H 'Content-Type: application/json' \   -d '{
      "name": "Snapshot X",   "description": "new snapshot" }'

Example: Response body of 201 successful response in JSON format

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "audit": {
        "createdBy": "string",
        "createdOn": "2024-06-13T17:44:13.920Z"
      },
      "status": "IN_PROGRESS",
      "validation": "IN_PROGRESS"
    }
  ],
  "count": 0
}

Back to Top