SP.RoleDefinitionCollection.getByType Method (sp.js)

Gets the role definition with the specified role type.

Applies to: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

SP.RoleDefinitionCollection.getByType()

Parameters

• roleType
  Type: SP.RoleType

  Returns a SP.RoleDefinition object (sp.js) instance with the specified role type.

Return value

Type: SP.RoleDefinition

REST resource endpoint

See RoleDefinitionCollection resource for more information.

Endpoint URI structure

http://<sitecollection>/<site>/_api/web/roledefinitions/getByType(roleType)

HTTP requests

This resource supports the following HTTP commands:

• POST

GET syntax

GET http://<sitecollection>/<site>/_api/web/roledefinitions/getByType(roleType)

POST syntax

POST http://<sitecollection>/<site>/_api/web/roledefinitions/getByType(roleType)

Resource parameters

• roleType