Get Information of a Deployed Decision Service by the Runtime Version ID
get
/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/tags/{tagId}/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. Making this GET request is equivalent to making a GET 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).
Request
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)
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
Response
Supported Media Types
- application/json
- text/plain
200 Response
Successful Response
Nested Schema : DecisionService-allOf[1]
Type:
Show Source
object
-
class:
string
Default Value:
. .DecisionService
-
inputData:
RestCollection
-
inputDecisions:
RestCollection
-
outputDecisions:
RestCollection
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