Skip to content

Retrieve a metaobject definition entry count

View as Markdown
get /api/metaobject_definitions/{definitionId}/entry_count

Retrieves a MetaobjectDefinitionCount resource.

Returns the number of entries of the metaobject definition identified by definitionId, whatever their status. Requires the metaobjects:read scope. This endpoint is only available in the unstable version.

Path parameters

NameTypeRequiredDescription
definitionIdstringrequiredMetaobjectDefinitionCount identifier

Query parameters

NameTypeRequiredDescription
properties[]string[]-Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}

Response

200 - MetaobjectDefinitionCount resource

PropertyTypeRequiredDescription
@contextstring | object-
@idstringrequired
@typestringrequired
countinteger-The number of entries of this metaobject definition, whatever their status.
definitionobject-The IRI of the metaobject definition the entries are counted for.
definitionIdstring-The identifier of the metaobject definition the entries are counted for.

Errors

403 - Access denied. The caller is missing one or more permissions required for this operation.

Content-Type: application/problem+json

PropertyTypeRequiredDescription
@contextstring | object-
@idstringrequired
@typestringrequired
detailstring-
missingPermissionsstring[]-Permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied permission.
statusinteger-
titlestring-
typestring-

404 - Not found

PropertyTypeRequiredDescription
@contextstring | object-
@idstringrequired
@typestringrequired
codestring-Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only.
descriptionstring | null-
detailstring | null-A human-readable explanation specific to this occurrence of the problem.
instancestring | null-A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
messagestring-End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only.
slugstring-Stable, readable key of the error in the error code catalogue. Present on catalogued errors only.
statusinteger | null-
titlestring | null-A short, human-readable summary of the problem. For a catalogued error it repeats the slug.
typestring-A URI reference that identifies the problem type. For a catalogued error it is the error code resource, /api/error-codes/{code}.