Jump to

• Request
• Response

Get Information about a Decision Service by Snapshot Name

get

/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/versions/{decisionModelVersion}/definition/decision-services/{decisionServiceName}

Gets the input argument and output returned from a decision service. The attribute interpretation in the response body contains JSON schema of the input arguments and return output. The snapshot name is identified by {decisionModelVersion}.

Request

Path Parameters

• decisionModelName(required): string
  Name of the Decision Model
• decisionModelVersion(required): string
  Decision model version ID, this is usually the snapshot name

  Default Value: LATEST
• decisionServiceName(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

Back to Top

Response

Supported Media Types

• application/json
• text/plain

200 Response

Successful Response

Body ()

Root Schema : DecisionService

Match All

Show Source

• object RestObject
• object DecisionService-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/RestObject"
        },
        {
            "properties":{
                "class":{
                    "type":"string",
                    "default":".\t.DecisionService"
                },
                "outputDecisions":{
                    "$ref":"#/definitions/RestCollection"
                },
                "inputData":{
                    "$ref":"#/definitions/RestCollection"
                },
                "inputDecisions":{
                    "$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 : DecisionService-allOf[1]

Type: object

Show Source

• class: string
  Default Value: . .DecisionService
• inputData: RestCollection
• inputDecisions: RestCollection
• outputDecisions: RestCollection

{
    "properties":{
        "class":{
            "type":"string",
            "default":".\t.DecisionService"
        },
        "outputDecisions":{
            "$ref":"#/definitions/RestCollection"
        },
        "inputData":{
            "$ref":"#/definitions/RestCollection"
        },
        "inputDecisions":{
            "$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":".DecisionService",
    "interpretation":{
        "$class":"function",
        "arguments":{
            "$schema":"http://json-schema.org/draft-04/schema#",
            "type":"object",
            "properties":{
                "InputInt":{
                    "$schema":"http://json-schema.org/draft-04/schema#",
                    "type":"number"
                }
            }
        },
        "returns":{
            "$schema":"http://json-schema.org/draft-04/schema#",
            "type":"object",
            "properties":{
                "interpretation":{
                    "$schema":"http://json-schema.org/draft-04/schema#",
                    "type":"number"
                },
                "problems":{
                    "$schema":"http://json-schema.org/draft-04/schema#",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "message":{
                                "$schema":"http://json-schema.org/draft-04/schema#",
                                "type":"string"
                            }
                        }
                    }
                }
            }
        }
    },
    "outputDecisions":{
        "@class":".DecisionService$DecisionReferenceCollection",
        "items":[
            {
                "@class":".DecisionService$DecisionReference",
                "name":"Plus One"
            }
        ]
    },
    "inputData":{
        "@class":".DecisionService$InputDataReferenceCollection",
        "items":[
            {
                "@class":".DecisionService$InputDataReference",
                "name":"InputInt"
            }
        ]
    },
    "inputDecisions":{
        "@class":".DecisionService$DecisionReferenceCollection"
    },
    "createdBy":"jstein",
    "createdTime":"2017/02/02T11:11:49",
    "lastChangedBy":"jstein",
    "lastChangedTime":"2017/02/02T11:12:44",
    "name":"Plus One Service"
}

401 Response

Unauthorized

403 Response

Forbidden (Expired or invalid token)

404 Response

Not Found

500 Response

Internal Server Error

Back to Top