View Source

Class ContentController

The API controller used for editing content

Inheritance

System.Object

UmbracoApiControllerBase

UmbracoApiController

UmbracoAuthorizedApiController

UmbracoAuthorizedJsonController

BackOfficeNotificationsController

ContentControllerBase

Namespace: Umbraco.Web.Editors

Assembly: Umbraco.Web.dll

Syntax

[PluginController("UmbracoApi")]
public class ContentController : ContentControllerBase, IDiscoverable

Remarks

This controller is decorated with the UmbracoApplicationAuthorizeAttribute which means that any user requesting access to ALL of the methods on this controller will need access to the content application.

Constructors

ContentController(PropertyEditorCollection, IGlobalSettings, IUmbracoContextAccessor, ISqlContext, ServiceContext, AppCaches, IProfilingLogger, IRuntimeState, UmbracoHelper, IScopeProvider)

Declaration

public ContentController(PropertyEditorCollection propertyEditors, IGlobalSettings globalSettings, IUmbracoContextAccessor umbracoContextAccessor, ISqlContext sqlContext, ServiceContext services, AppCaches appCaches, IProfilingLogger logger, IRuntimeState runtimeState, UmbracoHelper umbracoHelper, IScopeProvider scopeProvider)

Parameters

Type	Name	Description
PropertyEditorCollection	propertyEditors
IGlobalSettings	globalSettings
IUmbracoContextAccessor	umbracoContextAccessor
ISqlContext	sqlContext
ServiceContext	services
AppCaches	appCaches
IProfilingLogger	logger
IRuntimeState	runtimeState
UmbracoHelper	umbracoHelper
IScopeProvider	scopeProvider

Properties

Domains

Declaration

public object Domains { get; }

Property Value

Type	Description
System.Object

Methods

AllowsCultureVariation()

Returns true if any content types have culture variation enabled

Declaration

public bool AllowsCultureVariation()

Returns

Type	Description
System.Boolean

CreateBlueprintFromContent(Int32, String)

Creates a blueprint from a content item

Declaration

public SimpleNotificationModel CreateBlueprintFromContent(int contentId, string name)

Parameters

Type	Name	Description
System.Int32	contentId	The content id to copy
System.String	name	The name of the blueprint

Returns

Type	Description
SimpleNotificationModel

DeleteBlueprint(Int32)

Declaration

public HttpResponseMessage DeleteBlueprint(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
HttpResponseMessage

DeleteById(Int32)

Moves an item to the recycle bin, if it is already there then it will permanently delete it

Declaration

public HttpResponseMessage DeleteById(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
HttpResponseMessage

Remarks

The CanAccessContentAuthorize attribute will deny access to this method if the current user does not have Delete access to this node.

EmptyRecycleBin()

Empties the recycle bin

Declaration

public HttpResponseMessage EmptyRecycleBin()

Returns

Type	Description
HttpResponseMessage

Remarks

attributed with EnsureUserPermissionForContent to verify the user has access to the recycle bin

GetBlueprintById(Int32)

Declaration

public ContentItemDisplay GetBlueprintById(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
ContentItemDisplay

GetById(Guid)

Gets the content json for the content guid

Declaration

public ContentItemDisplay GetById(Guid id)

Parameters

Type	Name	Description
System.Guid	id

Returns

Type	Description
ContentItemDisplay

GetById(Int32)

Gets the content json for the content id

Declaration

public ContentItemDisplay GetById(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
ContentItemDisplay

GetById(Udi)

Gets the content json for the content udi

Declaration

public ContentItemDisplay GetById(Udi id)

Parameters

Type	Name	Description
Udi	id

Returns

Type	Description
ContentItemDisplay

GetByIds(Int32[])

Return content for the specified ids

Declaration

public IEnumerable<ContentItemDisplay> GetByIds(int[] ids)

Parameters

Type	Name	Description
System.Int32[]	ids

Returns

Type	Description
System.Collections.Generic.IEnumerable<ContentItemDisplay>

GetChildren(Int32, Int32, Int32, String, Direction, Boolean, String)

Gets the children for the content id passed in

Declaration

public PagedResult<ContentItemBasic<ContentPropertyBasic>> GetChildren(int id, int pageNumber = 0, int pageSize = 0, string orderBy = "SortOrder", Direction orderDirection = Direction.Ascending, bool orderBySystemField = true, string filter = "")

Parameters

Type	Name	Description
System.Int32	id
System.Int32	pageNumber
System.Int32	pageSize
System.String	orderBy
Direction	orderDirection
System.Boolean	orderBySystemField
System.String	filter

Returns

Type	Description
PagedResult<ContentItemBasic<ContentPropertyBasic>>

GetChildren(Int32, String, Int32, Int32, String, Direction, Boolean, String, String)

Gets the children for the content id passed in

Declaration

public PagedResult<ContentItemBasic<ContentPropertyBasic>> GetChildren(int id, string includeProperties, int pageNumber = 0, int pageSize = 0, string orderBy = "SortOrder", Direction orderDirection = Direction.Ascending, bool orderBySystemField = true, string filter = "", string cultureName = "")

Parameters

Type	Name	Description
System.Int32	id
System.String	includeProperties
System.Int32	pageNumber
System.Int32	pageSize
System.String	orderBy
Direction	orderDirection
System.Boolean	orderBySystemField
System.String	filter
System.String	cultureName

Returns

Type	Description
PagedResult<ContentItemBasic<ContentPropertyBasic>>

GetCultureAndDomains(Int32)

Declaration

public ContentDomainsAndCulture GetCultureAndDomains(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
ContentDomainsAndCulture

GetDetailedPermissions(Int32)

Returns the user group permissions for user groups assigned to this node

Declaration

public IEnumerable<AssignedUserGroupPermissions> GetDetailedPermissions(int contentId)

Parameters

Type	Name	Description
System.Int32	contentId

Returns

Type	Description
System.Collections.Generic.IEnumerable<AssignedUserGroupPermissions>

Remarks

Permission check is done for letter 'R' which is for ActionRights which the user must have access to view

GetEmpty(Int32, Int32)

Declaration

public ContentItemDisplay GetEmpty(int blueprintId, int parentId)

Parameters

Type	Name	Description
System.Int32	blueprintId
System.Int32	parentId

Returns

Type	Description
ContentItemDisplay

GetEmpty(String, Int32)

Gets an empty content item for the document type.

Declaration

public ContentItemDisplay GetEmpty(string contentTypeAlias, int parentId)

Parameters

Type	Name	Description
System.String	contentTypeAlias
System.Int32	parentId

Returns

Type	Description
ContentItemDisplay

GetEmptyByAliases(ContentTypesByAliases)

Gets a dictionary containing empty content items for every alias specified in the contentTypeAliases array in the body of the request.

Declaration

public IDictionary<string, ContentItemDisplay> GetEmptyByAliases(ContentTypesByAliases contentTypesByAliases)

Parameters

Type	Name	Description
ContentTypesByAliases	contentTypesByAliases

Returns

Type	Description
System.Collections.Generic.IDictionary<System.String, ContentItemDisplay>

Remarks

This is a post request in order to support a large amount of aliases without hitting the URL length limit.

GetEmptyByKey(Guid, Int32)

Gets an empty content item for the document type.

Declaration

public ContentItemDisplay GetEmptyByKey(Guid contentTypeKey, int parentId)

Parameters

Type	Name	Description
System.Guid	contentTypeKey
System.Int32	parentId

Returns

Type	Description
ContentItemDisplay

GetEmptyByKeys(Guid[], Int32)

Gets a collection of empty content items for all document types.

Declaration

public IDictionary<Guid, ContentItemDisplay> GetEmptyByKeys(Guid[] contentTypeKeys, int parentId)

Parameters

Type	Name	Description
System.Guid[]	contentTypeKeys
System.Int32	parentId

Returns

Type	Description
System.Collections.Generic.IDictionary<System.Guid, ContentItemDisplay>

GetEmptyByKeys(ContentTypesByKeys)

Gets a collection of empty content items for all document types.

Declaration

public IDictionary<Guid, ContentItemDisplay> GetEmptyByKeys(ContentTypesByKeys contentTypeByKeys)

Parameters

Type	Name	Description
ContentTypesByKeys	contentTypeByKeys

Returns

Type	Description
System.Collections.Generic.IDictionary<System.Guid, ContentItemDisplay>

Remarks

This is a post request in order to support a large amount of GUIDs without hitting the URL length limit.

GetNiceUrl(Guid)

Gets the Url for a given node ID

Declaration

public HttpResponseMessage GetNiceUrl(Guid id)

Parameters

Type	Name	Description
System.Guid	id

Returns

Type	Description
HttpResponseMessage

GetNiceUrl(Int32)

Gets the Url for a given node ID

Declaration

public HttpResponseMessage GetNiceUrl(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
HttpResponseMessage

GetNiceUrl(Udi)

Gets the Url for a given node ID

Declaration

public HttpResponseMessage GetNiceUrl(Udi id)

Parameters

Type	Name	Description
Udi	id

Returns

Type	Description
HttpResponseMessage

GetNotificationOptions(Int32)

Declaration

public IEnumerable<NotifySetting> GetNotificationOptions(int contentId)

Parameters

Type	Name	Description
System.Int32	contentId

Returns

Type	Description
System.Collections.Generic.IEnumerable<NotifySetting>

GetPagedContentVersions(Int32, Int32, Int32, String)

Declaration

public PagedResult<ContentVersionMetaViewModel> GetPagedContentVersions(int contentId, int pageNumber = 1, int pageSize = 10, string culture = null)

Parameters

Type	Name	Description
System.Int32	contentId
System.Int32	pageNumber
System.Int32	pageSize
System.String	culture

Returns

Type	Description
PagedResult<ContentVersionMetaViewModel>

GetPublicAccess(Int32)

Declaration

public HttpResponseMessage GetPublicAccess(int contentId)

Parameters

Type	Name	Description
System.Int32	contentId

Returns

Type	Description
HttpResponseMessage

GetRecycleBin()

Returns an item to be used to display the recycle bin for content

Declaration

public ContentItemDisplay GetRecycleBin()

Returns

Type	Description
ContentItemDisplay

GetRollbackVersion(Int32, String)

Declaration

public ContentVariantDisplay GetRollbackVersion(int versionId, string culture = null)

Parameters

Type	Name	Description
System.Int32	versionId
System.String	culture

Returns

Type	Description
ContentVariantDisplay

GetRollbackVersions(Int32, String)

Declaration

public IEnumerable<RollbackVersion> GetRollbackVersions(int contentId, string culture = null)

Parameters

Type	Name	Description
System.Int32	contentId
System.String	culture

Returns

Type	Description
System.Collections.Generic.IEnumerable<RollbackVersion>

PostCopy(MoveOrCopy)

Copies a content item and places the copy as a child of a given parent Id

Declaration

public HttpResponseMessage PostCopy(MoveOrCopy copy)

Parameters

Type	Name	Description
MoveOrCopy	copy

Returns

Type	Description
HttpResponseMessage

PostMove(MoveOrCopy)

Change the sort order for media

Declaration

public HttpResponseMessage PostMove(MoveOrCopy move)

Parameters

Type	Name	Description
MoveOrCopy	move

Returns

Type	Description
HttpResponseMessage

PostNotificationOptions(Int32, String[])

Declaration

public void PostNotificationOptions(int contentId, string[] notifyOptions)

Parameters

Type	Name	Description
System.Int32	contentId
System.String[]	notifyOptions

PostPublicAccess(Int32, String[], String[], Int32, Int32)

Declaration

public HttpResponseMessage PostPublicAccess(int contentId, string[] groups, string[] usernames, int loginPageId, int errorPageId)

Parameters

Type	Name	Description
System.Int32	contentId
System.String[]	groups
System.String[]	usernames
System.Int32	loginPageId
System.Int32	errorPageId

Returns

Type	Description
HttpResponseMessage

PostPublishById(Int32)

Publishes a document with a given ID

Declaration

public HttpResponseMessage PostPublishById(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
HttpResponseMessage

Remarks

The EnsureUserPermissionForContent attribute will deny access to this method if the current user does not have Publish access to this node.

PostRollbackContent(Int32, Int32, String)

Declaration

public HttpResponseMessage PostRollbackContent(int contentId, int versionId, string culture = "*")

Parameters

Type	Name	Description
System.Int32	contentId
System.Int32	versionId
System.String	culture

Returns

Type	Description
HttpResponseMessage

PostSave(ContentItemSave)

Saves content

Declaration

public ContentItemDisplay PostSave(ContentItemSave contentItem)

Parameters

Type	Name	Description
ContentItemSave	contentItem

Returns

Type	Description
ContentItemDisplay

PostSaveBlueprint(ContentItemSave)

Saves content

Declaration

public ContentItemDisplay PostSaveBlueprint(ContentItemSave contentItem)

Parameters

Type	Name	Description
ContentItemSave	contentItem

Returns

Type	Description
ContentItemDisplay

PostSaveLanguageAndDomains(DomainSave)

Declaration

public DomainSave PostSaveLanguageAndDomains(DomainSave model)

Parameters

Type	Name	Description
DomainSave	model

Returns

Type	Description
DomainSave

PostSaveUserGroupPermissions(UserGroupPermissionsSave)

Updates the permissions for a content item for a particular user group

Declaration

public IEnumerable<AssignedUserGroupPermissions> PostSaveUserGroupPermissions(UserGroupPermissionsSave saveModel)

Parameters

Type	Name	Description
UserGroupPermissionsSave	saveModel

Returns

Type	Description
System.Collections.Generic.IEnumerable<AssignedUserGroupPermissions>

Remarks

Permission check is done for letter 'R' which is for ActionRights which the user must have access to update

PostSetContentVersionPreventCleanup(Int32, Int32, Boolean)

Declaration

public HttpResponseMessage PostSetContentVersionPreventCleanup(int contentId, int versionId, bool preventCleanup)

Parameters

Type	Name	Description
System.Int32	contentId
System.Int32	versionId
System.Boolean	preventCleanup

Returns

Type	Description
HttpResponseMessage

PostSort(ContentSortOrder)

Change the sort order for content

Declaration

public HttpResponseMessage PostSort(ContentSortOrder sorted)

Parameters

Type	Name	Description
ContentSortOrder	sorted

Returns

Type	Description
HttpResponseMessage

PostUnpublish(UnpublishContent)

Unpublishes a node with a given Id and returns the unpublished entity

Declaration

public ContentItemDisplay PostUnpublish(UnpublishContent model)

Parameters

Type	Name	Description
UnpublishContent	model	The content and variants to unpublish

Returns

Type	Description
ContentItemDisplay

RemovePublicAccess(Int32)

Declaration

public HttpResponseMessage RemovePublicAccess(int contentId)

Parameters

Type	Name	Description
System.Int32	contentId

Returns

Type	Description
HttpResponseMessage