Skip to content

List immutable versions for one business function.

GET
/api/workspace/admin/function-catalog/{functionId}/versions
curl --request GET \
--url https://example.com/api/workspace/admin/function-catalog/example/versions
  • None
functionId
required
string
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

Immutable business function script version.

object
Id

Version identifier.

string
nullable
BusinessFunctionId

Owning function identifier.

string
nullable
VersionNumber

Monotonic version number within the function.

integer format: int32
Contract
integer format: int32
Allowed values: 0 1 2 3 5 6 7
ActionTargetScope
integer format: int32
Allowed values: 0 1 2 3
ActionInputClrTypeName

Action input CLR type name.

string
nullable
ActionInputSignatureHash

Action input signature hash.

string
nullable
ActionInputSchemaPayload

Immutable action input schema JSON payload, including field nullability and typed Boolean or Select defaults when declared.

string
nullable
ActionInputFormPayload

Action input Form metadata JSON payload.

string
nullable
ActionInputCardPayload

Action input-history Card metadata JSON payload.

string
nullable
CreatedAt

Creation timestamp.

string format: date-time
CreatedByUserId

User that created the version.

string
nullable
PublishedAt

Publication timestamp, when published.

string format: date-time
nullable
PublishedByUserId

User that published the version.

string
nullable
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": [
{
"Contract": 0,
"ActionTargetScope": 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"
}

Not Found

Media typeapplication/json
object
Data
Array<object>
nullable

Immutable business function script version.

object
Id

Version identifier.

string
nullable
BusinessFunctionId

Owning function identifier.

string
nullable
VersionNumber

Monotonic version number within the function.

integer format: int32
Contract
integer format: int32
Allowed values: 0 1 2 3 5 6 7
ActionTargetScope
integer format: int32
Allowed values: 0 1 2 3
ActionInputClrTypeName

Action input CLR type name.

string
nullable
ActionInputSignatureHash

Action input signature hash.

string
nullable
ActionInputSchemaPayload

Immutable action input schema JSON payload, including field nullability and typed Boolean or Select defaults when declared.

string
nullable
ActionInputFormPayload

Action input Form metadata JSON payload.

string
nullable
ActionInputCardPayload

Action input-history Card metadata JSON payload.

string
nullable
CreatedAt

Creation timestamp.

string format: date-time
CreatedByUserId

User that created the version.

string
nullable
PublishedAt

Publication timestamp, when published.

string format: date-time
nullable
PublishedByUserId

User that published the version.

string
nullable
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": [
{
"Contract": 0,
"ActionTargetScope": 0
}
],
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}