List Resource EventBus consumer states.
GET
/api/workspace/admin/resource-events/consumers
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://example.com/api/workspace/admin/resource-events/consumers?IncludeInactive=false"), Headers = { { "Authorization", "Bearer <token>" }, },};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://example.com/api/workspace/admin/resource-events/consumers?IncludeInactive=false';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://example.com/api/workspace/admin/resource-events/consumers?IncludeInactive=false' \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”IncludeInactive
boolean
access_token
string
Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Responses
Section titled “Responses”OK
Media typeapplication/json
object
Data
Array<object>
Current or inactive resource event consumer state.
object
Id
Consumer state identifier.
string
SourceKind
Consumer source kind.
string
SourceKey
Consumer source key.
string
ConsumerKey
Consumer key.
string
DisplayName
Display name, when provided.
string
SourceArtifactId
Pinned source artifact identifier, when applicable.
string
SourceArtifactHash
Pinned source artifact hash, when applicable.
string
SourceDbContextTypeName
Pinned source DbContext type name, when applicable.
string
DescriptorHash
Current descriptor hash.
string
DescriptorJson
Current descriptor snapshot JSON.
string
ActivationStartsAtUtc
Activation watermark; earlier events are not materialized for this state.
string format: date-time
InactiveAtUtc
Inactive timestamp, when the consumer state is no longer active.
string format: date-time
CreatedAtUtc
State creation timestamp.
string format: date-time
ModifiedAtUtc
Latest state mutation timestamp.
string format: date-time
Errors
Array<object>
object
Code
required
string
Message
required
string
Target
string
Field
string
Metadata
object
key
additional properties
string
Type
integer format: int32
Severity
integer format: int32
Warnings
Array<object>
object
Code
required
string
Message
required
string
Target
string
Field
string
Metadata
object
key
additional properties
string
Type
integer format: int32
Severity
integer format: int32
Success
boolean
Example
{ "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
Media typeapplication/json
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
key
additional properties
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}