Jump to

• Request
• Response

Get a Decision Model

get

/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}

Gets a decision model.

Request

Supported Media Types

• application/json

Path Parameters

• decisionModelName(required): string
  Name of the Decision Model
• spaceId(required): string
  Identifies the Process space in which the decision model was created.

Header Parameters

• Authorization(required): string
  Authorization header MUST be set to type Bearer and an access token must be provided i.e. 'Bearer '

  Default Value: Bearer XXXXX.XXXXX.XXXXX

Body ()

JSON representation of an empty decision model

Root Schema : DecisionModel

Match All

Show Source

• object RestObject
• object DecisionModel-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/RestObject"
        },
        {
            "properties":{
                "class":{
                    "type":"string",
                    "default":".DecisionModel"
                },
                "permissions":{
                    "$ref":"#/definitions/RestCollection"
                },
                "tags":{
                    "$ref":"#/definitions/RestCollection"
                },
                "versions":{
                    "$ref":"#/definitions/RestCollection"
                }
            }
        }
    ]
}

Nested Schema : RestObject

Type: object

Show Source

• createdTime: string
• description: string
• lastChangeBy: string
• lastChangeTime: string
• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "lastChangeTime":{
            "type":"string"
        },
        "lastChangeBy":{
            "type":"string"
        },
        "createdTime":{
            "type":"string"
        }
    }
}

Nested Schema : DecisionModel-allOf[1]

Type: object

Show Source

• class: string
  Default Value: .DecisionModel
• permissions: RestCollection
• tags: RestCollection
• versions: RestCollection

{
    "properties":{
        "class":{
            "type":"string",
            "default":".DecisionModel"
        },
        "permissions":{
            "$ref":"#/definitions/RestCollection"
        },
        "tags":{
            "$ref":"#/definitions/RestCollection"
        },
        "versions":{
            "$ref":"#/definitions/RestCollection"
        }
    }
}

Nested Schema : RestCollection

Match All

Show Source

• object RestObject
• object RestCollection-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/RestObject"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/RestObject"
                    }
                }
            }
        }
    ]
}

Nested Schema : RestCollection-allOf[1]

Type: object

Show Source

• items: array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RestObject"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object RestObject

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/RestObject"
    }
}

Back to Top

Response

Supported Media Types

• text/plain

200 Response

Successful operation

Body ()

Root Schema : DecisionModel

Match All

Show Source

• object RestObject
• object DecisionModel-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/RestObject"
        },
        {
            "properties":{
                "class":{
                    "type":"string",
                    "default":".DecisionModel"
                },
                "permissions":{
                    "$ref":"#/definitions/RestCollection"
                },
                "tags":{
                    "$ref":"#/definitions/RestCollection"
                },
                "versions":{
                    "$ref":"#/definitions/RestCollection"
                }
            }
        }
    ]
}

Nested Schema : RestObject

Type: object

Show Source

• createdTime: string
• description: string
• lastChangeBy: string
• lastChangeTime: string
• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "lastChangeTime":{
            "type":"string"
        },
        "lastChangeBy":{
            "type":"string"
        },
        "createdTime":{
            "type":"string"
        }
    }
}

Nested Schema : DecisionModel-allOf[1]

Type: object

Show Source

• class: string
  Default Value: .DecisionModel
• permissions: RestCollection
• tags: RestCollection
• versions: RestCollection

{
    "properties":{
        "class":{
            "type":"string",
            "default":".DecisionModel"
        },
        "permissions":{
            "$ref":"#/definitions/RestCollection"
        },
        "tags":{
            "$ref":"#/definitions/RestCollection"
        },
        "versions":{
            "$ref":"#/definitions/RestCollection"
        }
    }
}

Nested Schema : RestCollection

Match All

Show Source

• object RestObject
• object RestCollection-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/RestObject"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/RestObject"
                    }
                }
            }
        }
    ]
}

Nested Schema : RestCollection-allOf[1]

Type: object

Show Source

• items: array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RestObject"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object RestObject

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/RestObject"
    }
}

Example Response (application/json)

{
    "@class":".DecisionModel",
    "name":"Decision Model 4",
    "versions":{
        "@class":".RestCollection",
        "name":"versions",
        "items":[
        ]
    },
    "tags":{
        "@class":".RestCollection",
        "name":"tags"
    },
    "permissions":{
        "@class":".RestCollection",
        "name":"permissions"
    }
}

401 Response

Unauthorized

403 Response

Forbidden (Expired or invalid token)

404 Response

Not Found

500 Response

Internal Server Error

Back to Top