View Source

Class ManagementApiControllerBase

Inheritance
System.Object
Namespace: Umbraco.Cms.Api.Management.Controllers
Assembly: Umbraco.Cms.Api.Management.dll
Syntax
public abstract class ManagementApiControllerBase : Controller

Methods

View Source

CreatedAtAction<T>(Expression<Func<T, String>>, Object, String)

Declaration
protected IActionResult CreatedAtAction<T>(Expression<Func<T, string>> action, object routeValues, string resourceIdentifier)
Parameters
Type Name Description
System.Linq.Expressions.Expression<Func<T, System.String>> action
System.Object routeValues
System.String resourceIdentifier
Returns
Type Description
IActionResult
Type Parameters
Name Description
T
View Source

CreatedAtId<T>(Expression<Func<T, String>>, Guid)

Declaration
protected IActionResult CreatedAtId<T>(Expression<Func<T, string>> action, Guid id)
Parameters
Type Name Description
System.Linq.Expressions.Expression<Func<T, System.String>> action
Guid id
Returns
Type Description
IActionResult
Type Parameters
Name Description
T
View Source

CreatedAtPath<T>(Expression<Func<T, String>>, String)

Declaration
protected IActionResult CreatedAtPath<T>(Expression<Func<T, string>> action, string path)
Parameters
Type Name Description
System.Linq.Expressions.Expression<Func<T, System.String>> action
System.String path
Returns
Type Description
IActionResult
Type Parameters
Name Description
T
View Source

CurrentUser(IBackOfficeSecurityAccessor)

Declaration
protected static IUser CurrentUser(IBackOfficeSecurityAccessor backOfficeSecurityAccessor)
Parameters
Type Name Description
IBackOfficeSecurityAccessor backOfficeSecurityAccessor
Returns
Type Description
IUser
View Source

CurrentUserKey(IBackOfficeSecurityAccessor)

Declaration
protected static Guid CurrentUserKey(IBackOfficeSecurityAccessor backOfficeSecurityAccessor)
Parameters
Type Name Description
IBackOfficeSecurityAccessor backOfficeSecurityAccessor
Returns
Type Description
Guid
View Source

Forbidden()

Creates a 403 Forbidden result.

Declaration
protected IActionResult Forbidden()
Returns
Type Description
IActionResult
Remarks

Use this method instead of on the controller base. This method ensures that a proper 403 Forbidden status code is returned to the client.

View Source

OperationStatusResult<TEnum>(TEnum, Func<ProblemDetailsBuilder, IActionResult>)

Declaration
protected static IActionResult OperationStatusResult<TEnum>(TEnum status, Func<ProblemDetailsBuilder, IActionResult> result)
    where TEnum : Enum
Parameters
Type Name Description
TEnum status
Func<ProblemDetailsBuilder, IActionResult> result
Returns
Type Description
IActionResult
Type Parameters
Name Description
TEnum
View Source

SkipTakeToPagingProblem()

Declaration
protected BadRequestObjectResult SkipTakeToPagingProblem()
Returns
Type Description
BadRequestObjectResult