<back to all web services

WorkflowOperationMessage

The following routes are available for this service:
All Verbs/RestApi/sitefinity/inlineediting/workflow
"use strict";
/** @typedef {'Publish'|'SaveAsDraft'|'Custom'} */
export var InlineEditingOperation;
(function (InlineEditingOperation) {
    InlineEditingOperation["Publish"] = "Publish"
    InlineEditingOperation["SaveAsDraft"] = "SaveAsDraft"
    InlineEditingOperation["Custom"] = "Custom"
})(InlineEditingOperation || (InlineEditingOperation = {}));
export class ItemContextModel {
    /** @param {{ItemId?:string,ItemType?:string,Provider?:string,FieldValues?:FieldValueModel[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ItemId;
    /** @type {string} */
    ItemType;
    /** @type {string} */
    Provider;
    /** @type {FieldValueModel[]} */
    FieldValues;
}
export class WorkflowOperationMessage {
    /** @param {{PageId?:string,WorkflowOperation?:InlineEditingOperation,CustomWorkflowOperation?:string,Items?:ItemContextModel[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    PageId;
    /** @type {InlineEditingOperation} */
    WorkflowOperation;
    /** @type {string} */
    CustomWorkflowOperation;
    /** @type {ItemContextModel[]} */
    Items;
}
export class FieldValueModel {
    /** @param {{Name?:string,Value?:Object,ComplexValue?:FieldValueModel[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {Object} */
    Value;
    /** @type {FieldValueModel[]} */
    ComplexValue;
}

JavaScript 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
	}
]