Skip to content

List business functions from the synchronized runtime catalog.

GET
/api/workspace/admin/function-catalog
curl --request GET \
--url https://example.com/api/workspace/admin/function-catalog
  • None
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

OK

Media typeapplication/json
object
Data
Array<object>
nullable

Administrative business function summary.

object
Id

Function identifier.

string
nullable
Key

Stable function key.

string
nullable
Name

User-facing function name.

string
nullable
Description

Optional description.

string
nullable
Kind
integer format: int32
Allowed values: 0 1
EntityDefinitionId

Owning entity definition for entity functions.

string
nullable
IsEnabled

Whether the function can be invoked by future runtime slices.

boolean
CurrentPublishedVersionId

Current published version identifier.

string
nullable
CurrentPublishedContract
integer format: int32
Allowed values: 0 1 2 3 5 6 7
CreatedAt

Creation timestamp.

string format: date-time
ModifiedAt

Last metadata modification timestamp.

string format: date-time
nullable
ModifiedByUserId

Last modifying user identifier.

string
nullable
VersionCount

Number of stored immutable versions.

integer format: int32
LatestVersionNumber

Latest stored version number.

integer format: int32
nullable
LatestVersionPublishedAt

Publication timestamp for the latest stored version.

string format: date-time
nullable
CurrentPublishedVersionNumber

Current published version number.

integer format: int32
nullable
CurrentPublishedVersionPublishedAt

Publication timestamp for the current published version.

string format: date-time
nullable
LastRunStatus
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8
LastRunStartedAt

Most recent persisted run start timestamp.

string format: date-time
nullable
RowVersion

Concurrency token.

string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": [
{
"Kind": 0,
"CurrentPublishedContract": 0,
"LastRunStatus": 0
}
],
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}