<back to all web services

WorkflowOperationMessage

The following routes are available for this service:
All Verbs/RestApi/sitefinity/inlineediting/workflow
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


class InlineEditingOperation(str, Enum):
    PUBLISH = 'Publish'
    SAVE_AS_DRAFT = 'SaveAsDraft'
    CUSTOM = 'Custom'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ItemContextModel:
    item_id: Optional[str] = None
    item_type: Optional[str] = None
    provider: Optional[str] = None
    field_values: Optional[List[FieldValueModel]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkflowOperationMessage:
    page_id: Optional[str] = None
    workflow_operation: Optional[InlineEditingOperation] = None
    custom_workflow_operation: Optional[str] = None
    items: Optional[List[ItemContextModel]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FieldValueModel:
    name: Optional[str] = None
    value: Optional[Object] = None
    complex_value: Optional[List[FieldValueModel]] = None

Python WorkflowOperationMessage 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.

POST /RestApi/sitefinity/inlineediting/workflow HTTP/1.1 
Host: www.asg.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	PageId: String,
	WorkflowOperation: Publish,
	CustomWorkflowOperation: String,
	Items: 
	[
		{
			ItemId: String,
			ItemType: String,
			Provider: String,
			FieldValues: 
			[
				{
					Name: String,
					Value: {},
					ComplexValue: 
					[
						{
							Name: String,
							Value: {},
							ComplexValue: 
							[
								{
									Name: String,
									Value: {}
								}
							]
						}
					]
				}
			]
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		ItemName: String,
		ItemType: String,
		ItemStatus: 
		{
			DisplayStatus: String,
			IsAdmin: False,
			IsEditable: False,
			IsStatusEditable: False,
			IsLocked: False,
			IsPublished: False,
			IsLockedByMe: False,
			LockedByUsername: String,
			WorkflowStatus: String
		},
		ProviderName: String,
		DetailsViewUrl: String
	}
]