Jump to

• Request
• Response

Invoke a Deployed Decision Service by the Runtime Version ID

post

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

Invokes a deployed decision service by the runtime version ID. The request body should contain a map of Interpretations representing input data. The response body returns a DecisionServiceResult containing the Interpretation of output and any Problems encountered. Making this POST request is equivalent to making a POST request to /dmn/spaces/{spaceId}/decision-models/{decisionModelName}/versions/{decisionModelVersion}/definition/decision-services/{decisionServiceName}, in which {decisionModelVersion} is the name of the snapshot behind the corresponding runtime version Id. Note that only deployed snapshots (identified by decisionModelVersion) have a runtime version Id (identified by tagId) For example, if the arguments attribute of the response shows the following JSON schema: ```JSON {"arguments": { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "emp": { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "Emp_number": { "$schema": "http://json-schema.org/draft-04/schema#", "type": "number" }, "Emp_name": { "$schema": "http://json-schema.org/draft-04/schema#", "type": "string" } } } } } } ``` The request body of the post request should contain the JSON representation of emp object as shown: ```JSON { "emp" : { "Emp_name": "John Doe", "Emp_number": 3 } } ```

Request

Supported Media Types

• application/json

Path Parameters

• decisionModelName(required): string
  Name of the Decision Model
• decisionServiceName(required): string
  Name of the Decision Model
• spaceId(required): string
  Identifies the Process space in which the decision model was created.
• tagId(required): number
  Tag ID, this is usually the runtime version ID (e.g. 1.0, 2.0)

Body ()

Json representation of a map of interpretations representing the input data. Schema shows an sample object with 3 fields.

Root Schema : InvokeExample

Match All

Show Source

• object InvokeExample-allOf[0]
• object InvokeExampleProp

{
    "allOf":[
        {
            "properties":{
                "objectName":{
                    "type":"string"
                }
            }
        },
        {
            "$ref":"#/definitions/InvokeExampleProp"
        }
    ]
}

Nested Schema : InvokeExample-allOf[0]

Type: object

Show Source

• objectName: string

{
    "properties":{
        "objectName":{
            "type":"string"
        }
    }
}

Nested Schema : InvokeExampleProp

Type: object

Show Source

• field1: string
• field2: integer
• field3: integer

{
    "type":"object",
    "properties":{
        "field1":{
            "type":"string"
        },
        "field2":{
            "type":"integer"
        },
        "field3":{
            "type":"integer"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• text/plain

200 Response

Successful Response

401 Response

Unauthorized

403 Response

Forbidden (Expired or invalid token)

500 Response

Internal Server Error

Back to Top