Contents
Before you can access a SharePoint resource using the REST service, you first have to figure out the URI endpoint that points to that resource. Whenever possible, the URI for these REST endpoints closely mimics the API signature of the resource in the SharePoint client object model.
When to deviate from rest service endpoint Uris?
If the corresponding client object model method requires that complex types are passed as parameters, the REST endpoint may deviate from this syntax construction to account for REST limitations. Static methods and properties. REST endpoints deviate from this syntax structure for URIs that represent static methods and properties.
How to determine SharePoint rest service endpoints?
Determine SharePoint REST service endpoints. To construct a REST endpoint for a SharePoint resource, follow these steps: Start with the REST service reference: http://server/site/_api. Specify the appropriate entry point. For example: http://server/site/_api/web. Navigate from the entry point to the specific resources you want to access.
What is the use of API in SharePoint?
Use _api to denote the SharePoint REST service in your endpoint URIs. The REST service is part of the client.svc web service. However, to make REST URI construction easier and to shorten the base REST URI path, the REST service uses _api to abstract away the need to explicitly reference the client.svc web service.
We have explained in a previous article how to work with SharePoint list items, basically performing CRUD operations, using the combination of REST API and jQuery Ajax. The REST URI ends with any OData query operators to specify selecting, sorting, or filtering.
The endpoints in the SharePoint REST service correspond to the types and members in the SharePoint client object models. By using HTTP requests, you can use these REST endpoints to perform typical CRUD ( Create, Read, Update, and Delete) operations against SharePoint entities, such as lists and sites.
When to use variable name in URI template?
A variable name can be used more than once in the URI path template. If a character in the value of a variable would conflict with the reserved characters of a URI, the conflicting character should be substituted with percent encoding. For example, spaces in the value of a variable should be substituted with %20.
How to extract route values from a controller?
Extracts the route values { controller = Products, action = Details, id = 5 } by tokenizing the path. The extraction of route values results in a match if the app has a controller named ProductsController and a Details action: