CollectionResource

Properties

Name	Type	Description	Notes
id	string	The unique identifier (GUID)	[default to undefined]
internal_name	string	A name for this resource, for internal use only.	[default to undefined]
type	string	The type of collection: \'collection\', \'exhibition\', or \'gallery\'	[default to undefined]
language_id	string	The language this collection belongs to (LanguageResource id)	[default to undefined]
context_id	string	The context this collection belongs to (ContextResource id)	[default to undefined]
parent_id	string	The parent collection ID (for hierarchical organization)	[default to undefined]
display_order	string	The display order within sibling collections	[default to undefined]
backward_compatibility	string	The Id(s) of matching resource in the legacy system (if any).	[default to undefined]
created_at	string	The date of creation of the resource (managed by the system)	[default to undefined]
updated_at	string	The date of last modification of the resource (managed by the system)	[default to undefined]
language	LanguageResource	The language relationship (LanguageResource)	[optional] [default to undefined]
context	ContextResource	The context relationship (ContextResource)	[optional] [default to undefined]
parent	CollectionResource	The parent collection (CollectionResource)	[optional] [default to undefined]
children	Array<CollectionResource>	Child collections (CollectionResource[])	[optional] [default to undefined]
translations	Array<CollectionTranslationResource>	Translations for this collection (CollectionTranslationResource[])	[optional] [default to undefined]
partners	Array<PartnerResource>	Partners associated with this collection (PartnerResource[])	[optional] [default to undefined]
items	Array<ItemResource>	Items associated with this collection - primary relationship (ItemResource[])	[optional] [default to undefined]
attachedItems	Array<ItemResource>	Items attached to this collection via many-to-many relationship (ItemResource[])	[optional] [default to undefined]
items_count	number	The number of items in this collection (computed)	[optional] [default to undefined]
attached_items_count	number		[optional] [default to undefined]
partners_count	number		[optional] [default to undefined]
translations_count	number		[optional] [default to undefined]
children_count	number		[optional] [default to undefined]

Example

import { CollectionResource } from './api';

const instance: CollectionResource = {
    id,
    internal_name,
    type,
    language_id,
    context_id,
    parent_id,
    display_order,
    backward_compatibility,
    created_at,
    updated_at,
    language,
    context,
    parent,
    children,
    translations,
    partners,
    items,
    attachedItems,
    items_count,
    attached_items_count,
    partners_count,
    translations_count,
    children_count,
};

Back to Model list Back to API list Back to README

This documentation was automatically generated from the TypeScript API client.