View Source

Class DictionaryController

The API controller used for editing dictionary items

Inheritance

System.Object

Microsoft.AspNetCore.Mvc.ControllerBase

UmbracoApiControllerBase

UmbracoApiController

UmbracoAuthorizedApiController

UmbracoAuthorizedJsonController

BackOfficeNotificationsController

Namespace: Umbraco.Cms.Web.BackOffice.Controllers

Assembly: Umbraco.Web.BackOffice.dll

Syntax

[PluginController(null)]
[Authorize(Policy = "TreeAccessDictionary")]
public class DictionaryController : BackOfficeNotificationsController, IUmbracoFeature, IDiscoverable

Remarks

The security for this controller is defined to allow full CRUD access to dictionary if the user has access to either: Dictionary

Constructors

DictionaryController(ILogger<DictionaryController>, ILocalizationService, IBackOfficeSecurityAccessor, IOptions<GlobalSettings>, ILocalizedTextService, IUmbracoMapper)

Declaration

public DictionaryController(ILogger<DictionaryController> logger, ILocalizationService localizationService, IBackOfficeSecurityAccessor backofficeSecurityAccessor, IOptions<GlobalSettings> globalSettings, ILocalizedTextService localizedTextService, IUmbracoMapper umbracoMapper)

Parameters

Type	Name	Description
Microsoft.Extensions.Logging.ILogger<DictionaryController>	logger
ILocalizationService	localizationService
IBackOfficeSecurityAccessor	backofficeSecurityAccessor
Microsoft.Extensions.Options.IOptions<GlobalSettings>	globalSettings
ILocalizedTextService	localizedTextService
IUmbracoMapper	umbracoMapper

Methods

Create(Int32, String)

Creates a new dictionary item

Declaration

[HttpPost]
public ActionResult<int> Create(int parentId, string key)

Parameters

Type	Name	Description
System.Int32	parentId	The parent id.
System.String	key	The key.

Returns

Type	Description
Microsoft.AspNetCore.Mvc.ActionResult<System.Int32>	The System.Net.Http.HttpResponseMessage.

DeleteById(Int32)

Deletes a data type with a given ID

Declaration

[HttpDelete]
[HttpPost]
public IActionResult DeleteById(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
Microsoft.AspNetCore.Mvc.IActionResult	System.Net.Http.HttpResponseMessage

GetById(Guid)

Gets a dictionary item by guid

Declaration

public ActionResult<DictionaryDisplay> GetById(Guid id)

Parameters

Type	Name	Description
System.Guid	id	The id.

Returns

Type	Description
Microsoft.AspNetCore.Mvc.ActionResult<DictionaryDisplay>	The DictionaryDisplay. Returns a not found response when dictionary item does not exist

GetById(Int32)

Gets a dictionary item by id

Declaration

public ActionResult<DictionaryDisplay> GetById(int id)

Parameters

Type	Name	Description
System.Int32	id	The id.

Returns

Type	Description
Microsoft.AspNetCore.Mvc.ActionResult<DictionaryDisplay>	The DictionaryDisplay. Returns a not found response when dictionary item does not exist

GetById(Udi)

Gets a dictionary item by udi

Declaration

public ActionResult<DictionaryDisplay> GetById(Udi id)

Parameters

Type	Name	Description
Udi	id	The id.

Returns

Type	Description
Microsoft.AspNetCore.Mvc.ActionResult<DictionaryDisplay>	The DictionaryDisplay. Returns a not found response when dictionary item does not exist

GetList()

Retrieves a list with all dictionary items

Declaration

public IEnumerable<DictionaryOverviewDisplay> GetList()

Returns

Type	Description
System.Collections.Generic.IEnumerable<DictionaryOverviewDisplay>	The System.Collections.Generic.IEnumerable<T>.

PostMove(MoveOrCopy)

Changes the structure for dictionary items

Declaration

public IActionResult PostMove(MoveOrCopy move)

Parameters

Type	Name	Description
MoveOrCopy	move

Returns

Type	Description
Microsoft.AspNetCore.Mvc.IActionResult

PostSave(DictionarySave)

Saves a dictionary item

Declaration

public ActionResult<DictionaryDisplay> PostSave(DictionarySave dictionary)

Parameters

Type	Name	Description
DictionarySave	dictionary	The dictionary.

Returns

Type	Description
Microsoft.AspNetCore.Mvc.ActionResult<DictionaryDisplay>	The DictionaryDisplay.