Skip to content

Update admin-owned publication settings.

PUT
/api/workspace/admin/api-functions/{publicationId}/settings
curl --request PUT \
--url https://example.com/api/workspace/admin/api-functions/example/settings \
--header 'Content-Type: application/json' \
--data '{ "IsEnabled": true, "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'
  • None
publicationId
required
string
access_token
string

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

Request payload for updating admin-owned API publication settings.

object
IsEnabled

Whether the publication is invocable.

boolean
RowVersion

Optimistic concurrency token of the publication row.

string format: uuid
Examplegenerated
{
"IsEnabled": true,
"RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

OK

Media typeapplication/json
object
Data

Administration view of a command or API enqueue publication.

object
Id

Publication row identifier.

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

Callable function key.

string
nullable
DisplayName

Function display name.

string
nullable
Description

Function description.

string
nullable
PermissionKey

Permission key required to invoke the publication, when configured.

string
nullable
AllowAnyAuthenticatedUser

Whether every authenticated workspace user may invoke the publication.

boolean
TimeoutSeconds

Optional synchronous timeout override for command publications.

integer format: int32
nullable
IsEnabled

Admin-owned kill switch.

boolean
IsRetired

Whether the source function disappeared from the active descriptors.

boolean
BusinessFunctionId

Published function identifier.

string
nullable
FunctionName

Published function display name.

string
nullable
CreatedAt

Row creation timestamp.

string format: date-time
ModifiedAt

Last modification timestamp.

string format: date-time
nullable
RowVersion

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

Bad Request

Media typeapplication/json
object
Data

Administration view of a command or API enqueue publication.

object
Id

Publication row identifier.

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

Callable function key.

string
nullable
DisplayName

Function display name.

string
nullable
Description

Function description.

string
nullable
PermissionKey

Permission key required to invoke the publication, when configured.

string
nullable
AllowAnyAuthenticatedUser

Whether every authenticated workspace user may invoke the publication.

boolean
TimeoutSeconds

Optional synchronous timeout override for command publications.

integer format: int32
nullable
IsEnabled

Admin-owned kill switch.

boolean
IsRetired

Whether the source function disappeared from the active descriptors.

boolean
BusinessFunctionId

Published function identifier.

string
nullable
FunctionName

Published function display name.

string
nullable
CreatedAt

Row creation timestamp.

string format: date-time
ModifiedAt

Last modification timestamp.

string format: date-time
nullable
RowVersion

Optimistic 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
},
"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

Administration view of a command or API enqueue publication.

object
Id

Publication row identifier.

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

Callable function key.

string
nullable
DisplayName

Function display name.

string
nullable
Description

Function description.

string
nullable
PermissionKey

Permission key required to invoke the publication, when configured.

string
nullable
AllowAnyAuthenticatedUser

Whether every authenticated workspace user may invoke the publication.

boolean
TimeoutSeconds

Optional synchronous timeout override for command publications.

integer format: int32
nullable
IsEnabled

Admin-owned kill switch.

boolean
IsRetired

Whether the source function disappeared from the active descriptors.

boolean
BusinessFunctionId

Published function identifier.

string
nullable
FunctionName

Published function display name.

string
nullable
CreatedAt

Row creation timestamp.

string format: date-time
ModifiedAt

Last modification timestamp.

string format: date-time
nullable
RowVersion

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

Conflict

Media typeapplication/json
object
Data

Administration view of a command or API enqueue publication.

object
Id

Publication row identifier.

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

Callable function key.

string
nullable
DisplayName

Function display name.

string
nullable
Description

Function description.

string
nullable
PermissionKey

Permission key required to invoke the publication, when configured.

string
nullable
AllowAnyAuthenticatedUser

Whether every authenticated workspace user may invoke the publication.

boolean
TimeoutSeconds

Optional synchronous timeout override for command publications.

integer format: int32
nullable
IsEnabled

Admin-owned kill switch.

boolean
IsRetired

Whether the source function disappeared from the active descriptors.

boolean
BusinessFunctionId

Published function identifier.

string
nullable
FunctionName

Published function display name.

string
nullable
CreatedAt

Row creation timestamp.

string format: date-time
ModifiedAt

Last modification timestamp.

string format: date-time
nullable
RowVersion

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