SharePoint 2013 .NET Server, CSOM, JSOM, and REST API index

apps for SharePoint

Last modified: April 11, 2014

Applies to: apps for SharePoint | SharePoint Server 2013

Use the API index look up many of the most frequently used types and objects that are implemented in the .NET server object model and at least one client programming model: .NET client-side object model (CSOM), JavaScript object model (JSOM), and/or REST.

Table 1 lists the most frequently used, core APIs, which are in most cases based on types from the .NET server implementation. In some cases, types are native to SharePoint client programming, and there is no equivalent .NET server type. In other cases, some but not all possible client programming model implementations of a specific type exist.

Table 1. Frequently used Core APIs

.NET Server type

CSOM type

JSOM object

REST endpoint

SPAttachmentCollection

AttachmentCollection

SP.AttachmentCollection object (sp.js)

…/_api/web/lists('<list id>')/items(<item id>)/attachmentfiles

SPBasePermissions

BasePermissions

SP.BasePermissions object (sp.js)

SPCalendarType

CalendarType

SP.CalendarType enumeration (sp.js)

SPChangeCollection

ChangeCollection

SP.ChangeCollection object (sp.js)

…/_api/web/getchanges(changequery)

SPChangeSite

ChangeSite

SP.ChangeSite enumeration (sp.js)

ClientContext

SP.ClientContext object (sp.js)

…/_api/contextinfo

SPContentType

ContentType

SP.ContentType object (sp.js)

…/_api/web/contenttypes('<content type id>')

SPContentTypeCollection

ContentTypeCollection

SP.ContentTypeCollection object (sp.js)

…/_api/web/contenttypes

SPContext

SP.RequestContext object (sp.js)

SPEventReceiverDefinition

EventReceiverDefinition

SP.EventReceiverDefinition object (sp.js)

…/_api/web/eventreceivers

SPEventReceiverDefinitionCollection

EventReceiverDefinitionCollection

SP.EventReceiverDefinitionCollection object (sp.js)

…/_api/web/eventreceivers(eventreceiverid)

SPEventReceiverDefinitionCreationInformation

EventReceiverDefinitionCreationInformation

SP.EventReceiverDefinitionCreationInformation object (sp.js)

SPEventReceiverType

EventReceiverType

SP.EventReceiverType enumeration (sp.js)

SPFeature

Feature

SP.Feature object (sp.js)

…/_api/web/features(featureid)

SPFeatureCollection

FeatureCollection

SP.FeatureCollection object (sp.js)

…/_api/web/features

SPFeatureDefinitionScope

FeatureDefinitionScope

SP.FeatureDefinitionScope enumeration (sp.js)

SPField

Field

SP.Field object (sp.js)

…/_api/web/fields('<field id>')

SPFieldCalculated

FieldCalculated

SP.FieldCalculated object (sp.js)

…/_api/web/fields('<field id>')

SPFieldChoice

FieldChoice

SP.FieldChoice object (sp.js)

…/_api/web/fields('<field id>')

SPFieldCollection

FieldCollection

SP.FieldCollection object (sp.js)

…/_api/web/fields

SPFieldComputed

FieldComputed

SP.FieldComputed object (sp.js)

…/_api/web/fields('<field id>')

SPFieldCurrency

FieldCurrency

SP.FieldCurrency object (sp.js)

…/_api/web/fields('<field id>')

SPFieldLink

FieldLink

SP.FieldLink object (sp.js)

…/_api/web/contenttypes('<content type id>')/fieldlinks('<field link id>')

SPFieldLookupValue

FieldLookupValue

SP.FieldLookup object (sp.js)

SPFieldMultiChoice

FieldMultiChoice

SP.FieldMultiChoice object (sp.js)

…/_api/web/fields('<field id>')

SPFieldMultiLineText

FieldMultiLineText

SP.FieldMultiLineText object (sp.js)

…/_api/web/fields('<field id>')

SPFieldNumber

FieldNumber

SP.FieldNumber object (sp.js)

…/_api/web/fields('<field id>')

SPFieldText

FieldText

SP.FieldText object (sp.js)

…/_api/web/fields('<field id>')

SPFieldUrl

FieldUrl

SP.FieldUrl object (sp.js)

…/_api/web/fields('<field id>')

SPFieldUrlValue

FieldUrlValue

SP.FieldUrlValue object (sp.js)

SPFieldUser

FieldUser

SP.FieldUser object (sp.js)

…/_api/web/fields('<field id>')

SPFile

File

SP.File object (sp.js)

…/_api/web/getfilebyserverrelativeurl('/<folder name>/<file name>')

SPFileCollection

FileCollection

SP.FieldCollection object (sp.js)

…/_api/web/getfolderbyserverrelativeurl('/<folder name>')/files

SPFolder

Folder

SP.Folder object (sp.js)

…/_api/web/getfolderbyserverrelativeurl('/<folder name>')

SPForm

Form

SP.Form object (sp.js)

…/_api/web/lists(guid'<list id>')/forms('<form id>')

SPGroup

Group

SP.Group object (sp.js)

…/_api/web/sitegroups(<group id>)

SPGroupCollection

GroupCollection

SP.GroupCollection object (sp.js)

…/_api/web/sitegroups

SPLanguage

Language

SP.Language object (sp.js)

SPList

List

SP.List object (sp.js)

…/_api/web/lists(guid'<list id>')

SPListCollection

ListCollection

SP.ListCollection object (sp.js)

…/_api/web/lists

SPListDataSource

ListDataSource

SP.ListDataSource object (sp.js)

SPListItem

ListItem

SP.ListItem object (sp.js)

…/_api/web/lists(guid'<list id>')/items(<item id>)

SPListItemCollection

ListItemCollection

SP.ListItemCollection object (sp.js)

…/_api/web/lists(guid'<list id>')/items

SPListTemplateType

ListTemplateType

SP.ListTemplateType enumeration (sp.js)

SPNavigation

Navigation

SP.Navigation object (sp.js)

…/_api/web/navigation

SPNavigationNode

NavigationNode

SP.NavigationNode object (sp.js)

SPPrincipal

Principal

SP.Principal object (sp.js)

SPQuery

SPRecycleBinItem

RecycleBinItem

SP.RecycleBinItem object (sp.js)

…/_api/web/RecycleBin(recyclebinitemid)

SPRecycleBinItemCollection

RecycleBinItemCollection

SP.RecycleBinItemCollection object (sp.js)

…/_api/web/RecycleBin

SPRegionalSettings

RegionalSettings

SP.RegionalSettings object (sp.js)

…/_api/web/RegionalSettings

SPRoleAssignment

RoleAssignment

SP.RoleAssignment object (sp.js)

…/_api/web/roleassignments(<principal id>)

SPRoleAssignmentCollection

RoleAssignmentCollection

SP.RoleAssignmentCollection object (sp.js)

…/_api/web/roleassignments

SPRoleDefinition

RoleDefinition

SP.RoleDefinition object (sp.js)

…/_api/web/roledefinitions(<role definition id>)

SPRoleType

RoleType

SP.RoleType enumeration (sp.js)

SPSecurableObject

SecurableObject

SP.SecurableObject object (sp.js)

SPSite

Site

SP.Site object (sp.js)

…/_api/site

SPTimeZone

TimeZone

SP.TimeZone object (sp.js)

…/_api/web/RegionalSettings/TimeZones(timzoneid)

SPTimeZoneCollection

TimeZoneCollection

SP.TimeZoneCollection object (sp.js)

…/_api/web/RegionalSettings/TimeZones

SPUser

User

SP.User object (sp.js)

…/_api/web/siteusers(@v)?@v='<login name>'

SPUserCollection

UserCollection

SP.UserCollection object (sp.js)

…/_api/web/sitegroups(<group id>)/users

SPUtility

Utility

SP.Utilities.Utility object (sp.js)

SPView

View

SP.View object (sp.js)

…/_api/web/lists(guid'<list id>')/views('<view id>')

SPViewCollection

ViewCollection

SP.ViewCollection object (sp.js)

…/_api/web/lists(guid'<list id>')/views

SPViewFieldCollection

ViewFieldCollection

SP.ViewFieldCollection object (sp.js)

…/_api/web/lists(guid'<list id>')/views('<view id>')/fields

SPWeb

Web

SP.Web object (sp.js)

…/_api/web

SPWebCollection

WebCollection

SP.WebCollection object (sp.js)

…/_api/web/webs

SPWebInfo

WebInformation

SP.WebInformation object (sp.js)

…/_api/web/webinfos('<web information id>')

SPWebTemplate

WebTemplate

SP.WebTemplate object (sp.js)

…/_api/web/GetAvailableWebTemplates(languageid,includecrosslanguage)/getbyname(templatename)

SPWebTemplateCollection

WebTemplateCollection

SP.WebTemplateCollection object (sp.js)

…/_api/web/GetAvailableWebTemplates(languageid,includecrosslanguage)

Note Note

Before using a REST endpoint URI shown in the table, replace the abbreviation with the path to your SharePoint site, for example http://<site collection>/<site>/_api/web/lists.

Show:
© 2014 Microsoft