ItemResource

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]
backward_compatibility	string	The Id(s) of matching resource in the legacy system (if any).	[default to undefined]
type	ItemType	The type of the item: \'object\', \'monument\', \'detail\', or \'picture\'.	[default to undefined]
parent_id	string	The parent item ID (for hierarchical relationships), nullable	[default to undefined]
display_order	number	Display order among siblings sharing the same parent, nullable	[default to undefined]
owner_reference	string	Owner\'s reference number for the item (external reference from owner)	[default to undefined]
mwnf_reference	string	MWNF reference number for the item (reference from MWNF system)	[default to undefined]
start_date	number	The start year for the item (for datation purposes)	[default to undefined]
end_date	number	The end year for the item (for datation purposes)	[default to undefined]
parent	ItemResource	The parent item (for hierarchical relationships), nullable (ItemResource)	[optional] [default to undefined]
children	Array<ItemResource>	The child items (for hierarchical relationships) (ItemResource[])	[optional] [default to undefined]
partner	PartnerResource	The partner owning the item (PartnerResource)	[optional] [default to undefined]
project	ProjectResource	The project this item belongs to, nullable (ProjectResource)	[optional] [default to undefined]
country	CountryResource	The country this item is associated with, nullable (CountryResource)	[optional] [default to undefined]
collection	CollectionResource	The collection that contains this item (CollectionResource)	[optional] [default to undefined]
artists	Array<ArtistResource>	Artists associated with this item (ArtistResource[])	[optional] [default to undefined]
workshops	Array<WorkshopResource>	Workshops associated with this item (WorkshopResource[])	[optional] [default to undefined]
tags	Array<TagResource>	Tags associated with this item (TagResource[])	[optional] [default to undefined]
translations	Array<ItemTranslationResource>	Translations for this item (internationalization and contextualization) (ItemTranslationResource[])	[optional] [default to undefined]
itemImages	Array<ItemImageResource>	Item images attached to this item with display ordering (ItemImageResource[])	[optional] [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]

Example

import { ItemResource } from './api';

const instance: ItemResource = {
    id,
    internal_name,
    backward_compatibility,
    type,
    parent_id,
    display_order,
    owner_reference,
    mwnf_reference,
    start_date,
    end_date,
    parent,
    children,
    partner,
    project,
    country,
    collection,
    artists,
    workshops,
    tags,
    translations,
    itemImages,
    created_at,
    updated_at,
};

Back to Model list Back to API list Back to README

This documentation was automatically generated from the TypeScript API client.