Skip to content

Return one globally paged mixed content result for a Classifier Catalog.

POST
/api/workspace/catalogs/{catalogDefinitionId}/content/query
curl --request POST \
--url https://example.com/api/workspace/catalogs/example/content/query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "CatalogNodeId": "example", "Scope": 0, "EntityDefinitionIds": [ "example" ], "Search": "example", "SortField": 0, "SortDirection": 0, "Page": 1, "PageSize": 1 }'
catalogDefinitionId
required
string
access_token
string

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

Catalog-oriented query over active entity instances classified by one classifier.

object
CatalogNodeId

Selected category identifier, or null when Scope is Moltaro.Enums.Catalogs.CatalogContentScopeEnum.All.

string
nullable
Scope
integer format: int32
Allowed values: 0 1 2
EntityDefinitionIds

Optional Entity Definition type filter.

Array<string>
nullable
Search

Optional case-insensitive search over readable display name, number, and subtitle projections.

string
nullable
SortField
integer format: int32
Allowed values: 0 1 2
SortDirection
integer format: int32
Allowed values: 0 1
Page

One-based page number. Values below one are rejected.

integer format: int32
PageSize

Page size from 1 through 250.

integer format: int32

OK

Media typeapplication/json
object
Data

One globally paged mixed Catalog content result.

object
Items

Lightweight readable projections and restricted shells.

Array<object>
nullable

One lightweight mixed Catalog content item.

object
Resource

Stable identity of one Moltaro resource instance.

object
ModuleKey
string
nullable
ResourceKind
string
nullable
ContextResourceId
string
nullable
ResourceObjectId
string
nullable
CanView

Whether the current actor may currently read the Entity Instance.

boolean
CanUpdate

Whether the current actor may currently update the Entity Instance.

boolean
DisplayName

Persisted display projection, or null for a restricted shell.

string
nullable
Number

Persisted record number, or null for a restricted shell.

string
nullable
Subtitle

Persisted subtitle projection, or null for a restricted shell.

string
nullable
ClassifierAssignments

Readable matching Classifier field assignments.

Array<object>
nullable

One matching Classifier field assignment for a Catalog content item.

object
EntityFieldId

Classifier Entity Field identifier.

string
nullable
CatalogNodeId

Currently assigned category identifier.

string
nullable
CanRemove

Whether the current actor may clear this exact field assignment.

boolean
TotalCount

Total matching active resources before pagination.

integer format: int64
Page

One-based page number.

integer format: int32
PageSize

Applied page size.

integer format: int32
AvailableEntityDefinitions

All active Entity Definition types bound to this Classifier.

Array<object>
nullable

One Entity Definition available to the Catalog content type filter.

object
EntityDefinitionId

Entity Definition identifier.

string
nullable
DisplayNameSingular

User-facing singular type name.

string
nullable
DisplayNamePlural

User-facing plural type name.

string
nullable
ClassifierFields

Readable primary-table Classifier fields bound to the Catalog.

Array<object>
nullable

One Classifier field bound to this Catalog for an Entity Definition.

object
EntityFieldId

Entity Field identifier.

string
nullable
Key

Stable Entity Field key.

string
nullable
DisplayName

User-facing Entity Field name.

string
nullable
CanAssign

Whether this field may participate in Catalog-side assignment for the actor.

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

Bad Request

Media typeapplication/json
object
Data

One globally paged mixed Catalog content result.

object
Items

Lightweight readable projections and restricted shells.

Array<object>
nullable

One lightweight mixed Catalog content item.

object
Resource

Stable identity of one Moltaro resource instance.

object
ModuleKey
string
nullable
ResourceKind
string
nullable
ContextResourceId
string
nullable
ResourceObjectId
string
nullable
CanView

Whether the current actor may currently read the Entity Instance.

boolean
CanUpdate

Whether the current actor may currently update the Entity Instance.

boolean
DisplayName

Persisted display projection, or null for a restricted shell.

string
nullable
Number

Persisted record number, or null for a restricted shell.

string
nullable
Subtitle

Persisted subtitle projection, or null for a restricted shell.

string
nullable
ClassifierAssignments

Readable matching Classifier field assignments.

Array<object>
nullable

One matching Classifier field assignment for a Catalog content item.

object
EntityFieldId

Classifier Entity Field identifier.

string
nullable
CatalogNodeId

Currently assigned category identifier.

string
nullable
CanRemove

Whether the current actor may clear this exact field assignment.

boolean
TotalCount

Total matching active resources before pagination.

integer format: int64
Page

One-based page number.

integer format: int32
PageSize

Applied page size.

integer format: int32
AvailableEntityDefinitions

All active Entity Definition types bound to this Classifier.

Array<object>
nullable

One Entity Definition available to the Catalog content type filter.

object
EntityDefinitionId

Entity Definition identifier.

string
nullable
DisplayNameSingular

User-facing singular type name.

string
nullable
DisplayNamePlural

User-facing plural type name.

string
nullable
ClassifierFields

Readable primary-table Classifier fields bound to the Catalog.

Array<object>
nullable

One Classifier field bound to this Catalog for an Entity Definition.

object
EntityFieldId

Entity Field identifier.

string
nullable
Key

Stable Entity Field key.

string
nullable
DisplayName

User-facing Entity Field name.

string
nullable
CanAssign

Whether this field may participate in Catalog-side assignment for the actor.

boolean
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
{
"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

One globally paged mixed Catalog content result.

object
Items

Lightweight readable projections and restricted shells.

Array<object>
nullable

One lightweight mixed Catalog content item.

object
Resource

Stable identity of one Moltaro resource instance.

object
ModuleKey
string
nullable
ResourceKind
string
nullable
ContextResourceId
string
nullable
ResourceObjectId
string
nullable
CanView

Whether the current actor may currently read the Entity Instance.

boolean
CanUpdate

Whether the current actor may currently update the Entity Instance.

boolean
DisplayName

Persisted display projection, or null for a restricted shell.

string
nullable
Number

Persisted record number, or null for a restricted shell.

string
nullable
Subtitle

Persisted subtitle projection, or null for a restricted shell.

string
nullable
ClassifierAssignments

Readable matching Classifier field assignments.

Array<object>
nullable

One matching Classifier field assignment for a Catalog content item.

object
EntityFieldId

Classifier Entity Field identifier.

string
nullable
CatalogNodeId

Currently assigned category identifier.

string
nullable
CanRemove

Whether the current actor may clear this exact field assignment.

boolean
TotalCount

Total matching active resources before pagination.

integer format: int64
Page

One-based page number.

integer format: int32
PageSize

Applied page size.

integer format: int32
AvailableEntityDefinitions

All active Entity Definition types bound to this Classifier.

Array<object>
nullable

One Entity Definition available to the Catalog content type filter.

object
EntityDefinitionId

Entity Definition identifier.

string
nullable
DisplayNameSingular

User-facing singular type name.

string
nullable
DisplayNamePlural

User-facing plural type name.

string
nullable
ClassifierFields

Readable primary-table Classifier fields bound to the Catalog.

Array<object>
nullable

One Classifier field bound to this Catalog for an Entity Definition.

object
EntityFieldId

Entity Field identifier.

string
nullable
Key

Stable Entity Field key.

string
nullable
DisplayName

User-facing Entity Field name.

string
nullable
CanAssign

Whether this field may participate in Catalog-side assignment for the actor.

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