Version 2.0

Get Model Function

GET/api/v2/models/{modelRid}/function

Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Gets the function for the model.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:models-read.

Path parameters

modelRid

string

The Resource Identifier (RID) of a Model.

Query parameters

preview

booleanoptional

Enables the use of preview functionality.

Response body

ModelFunction

object

Hide child attributes

functionRid

string

functionVersion

string

displayName

string

apiName

string

isRowWise

boolean

ontologyBinding

stringoptional

The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the List ontologies endpoint or check the Ontology Manager.

Examples

Request

Copied!

curl \
\t-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/models/ri.models.main.model.f351c142-0e4c-4b12-adc2-6e1539737ae9/function?preview=true"

Response

Copied!

{
  "apiName": "myModelFunction",
  "ontologyBinding": "ri.ontology.main.ontology.a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "isRowWise": false,
  "functionVersion": "0.0.1",
  "displayName": "Core.DisplayName",
  "functionRid": "ri.function-registry.main.function.a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Error responses

Error Name
`ModelFunctionNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The given ModelFunction could not be found.
	Parameters	`modelRid`
`ModelNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The given Model could not be found.
	Parameters	`modelRid`

See Errors for a general overview of errors in the platform.