<back to all web services

RelationChangeMessage

The following routes are available for this service:
PUT/RestApi/sitefinity/related-data/relations
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RelationChangeMessage:
    item_id: Optional[str] = None
    item_type: Optional[str] = None
    item_provider: Optional[str] = None
    relation_changes: Optional[List[ContentLinkChange]] = None


class ContentLinkChangeState(str, Enum):
    ADDED = 'Added'
    REMOVED = 'Removed'
    UPDATED = 'Updated'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContentLinkChange:
    state: Optional[ContentLinkChangeState] = None
    child_item_id: Optional[str] = None
    child_item_provider_name: Optional[str] = None
    child_item_type: Optional[str] = None
    child_item_additional_info: Optional[str] = None
    ordinal: Optional[float] = None
    component_property_name: Optional[str] = None

Python RelationChangeMessage DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /RestApi/sitefinity/related-data/relations HTTP/1.1 
Host: www.asg.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ItemId: String,
	ItemType: String,
	ItemProvider: String,
	RelationChanges: 
	[
		{
			State: Added,
			ChildItemProviderName: String,
			ChildItemType: String,
			ChildItemAdditionalInfo: String,
			Ordinal: 0,
			ComponentPropertyName: String,
			IsChildDeleted: False
		}
	]
}