Reading Fields for a List using REST API SharePoint 2013

-
We can read the all the fields in a SharePoint list by consuming the REST endpoint:

http://server/_api/lists/getbytitle('listname')/fields

for example, below url retrieves  all the fields in the library(or list) Accounts:

https://xxx.sharepoint.com/_api/lists/getbytitle('Accounts')/fields

Return value: (I have marked in yellow, some of the important noticeable properties).

{
    "d": {
        "results": [
            {
                {
                "__metadata": {
                    "id": "https://xxx.sharepoint.com/_api/Web/Lists(guid'd5f89928-6c33-476d-a80c-54fcf0d57164')/Fields(guid'0953b0e6-65c1-41e8-98da-869f106b0669')",
                    "uri": "https://xxx.sharepoint.com/_api/Web/Lists(guid'd5f89928-6c33-476d-a80c-54fcf0d57164')/Fields(guid'0953b0e6-65c1-41e8-98da-869f106b0669')",
                    "type": "SP.FieldText"
                },
                "DescriptionResource": {
                    "__deferred": {
                        "uri": "https://xxx.sharepoint.com/_api/Web/Lists(guid'd5f89928-6c33-476d-a80c-54fcf0d57164')/Fields(guid'0953b0e6-65c1-41e8-98da-869f106b0669')/DescriptionResource"
                    }
                },
                "TitleResource": {
                    "__deferred": {
                        "uri": "https://xxx.sharepoint.com/_api/Web/Lists(guid'd5f89928-6c33-476d-a80c-54fcf0d57164')/Fields(guid'0953b0e6-65c1-41e8-98da-869f106b0669')/TitleResource"
                    }
                },
                "AutoIndexed": false,
                "CanBeDeleted": true,
                "DefaultValue": null,
                "Description": "",
                "Direction": "none",
                "EnforceUniqueValues": false,
                "EntityPropertyName": "AccountId",
                "Filterable": true,
                "FromBaseType": false,
                "Group": "Custom Columns",
                "Hidden": false,
                "Id": "0953b0e6-65c1-41e8-98da-869f106b0669",
                "Indexed": false,
                "InternalName": "AccountId",
                "JSLink": "clienttemplates.js",
                "ReadOnlyField": false,
                "Required": false,
                "SchemaXml": "<Field Type=\"Text\" DisplayName=\"AccountId\" Required=\"FALSE\" EnforceUniqueValues=\"FALSE\" Indexed=\"FALSE\" MaxLength=\"255\" ID=\"{0953b0e6-65c1-41e8-98da-869f106b0669}\" SourceID=\"{d5f89928-6c33-476d-a80c-54fcf0d57164}\" StaticName=\"AccountId\" Name=\"AccountId\" ColName=\"nvarchar10\" RowOrdinal=\"0\" />",
                "Scope": "/SalesForce Files",
                "Sealed": false,
                "Sortable": true,
                "StaticName": "AccountId",
                "Title": "AccountId",
                "FieldTypeKind": 2,
                "TypeAsString": "Text",
                "TypeDisplayName": "Single line of text",
                "TypeShortDescription": "Single line of text",
                "ValidationFormula": null,
                "ValidationMessage": null,
                "MaxLength": 255
            },
            {
                "__metadata": {
                    "id": "https://xxx.sharepoint.com/_api/Web/Lists(guid'd5f89928-6c33-476d-a80c-54fcf0d57164')/Fields(guid'7d522db6-c085-4161-bbff-d11a538c57a9')",
                    "uri": "https://xxx.sharepoint.com/_api/Web/Lists(guid'd5f89928-6c33-476d-a80c-54fcf0d57164')/Fields(guid'7d522db6-c085-4161-bbff-d11a538c57a9')",
                    "type": "SP.FieldText"
                },
                "DescriptionResource": {
                    "__deferred": {
                        "uri": "https://xxx.sharepoint.com/_api/Web/Lists(guid'd5f89928-6c33-476d-a80c-54fcf0d57164')/Fields(guid'7d522db6-c085-4161-bbff-d11a538c57a9')/DescriptionResource"
                    }
                },
                "TitleResource": {
                    "__deferred": {
                        "uri": "https://xxx.sharepoint.com/_api/Web/Lists(guid'd5f89928-6c33-476d-a80c-54fcf0d57164')/Fields(guid'7d522db6-c085-4161-bbff-d11a538c57a9')/TitleResource"
                    }
                },
                "AutoIndexed": false,
                "CanBeDeleted": true,
                "DefaultValue": null,
                "Description": "",
                "Direction": "none",
                "EnforceUniqueValues": false,
                "EntityPropertyName": "File_x0020_Type0",
                "Filterable": true,
                "FromBaseType": false,
                "Group": "Custom Columns",
                "Hidden": false,
                "Id": "7d522db6-c085-4161-bbff-d11a538c57a9",
                "Indexed": false,
                "InternalName": "File_x0020_Type0",
                "JSLink": "clienttemplates.js",
                "ReadOnlyField": false,
                "Required": false,
                "SchemaXml": "<Field Type=\"Text\" DisplayName=\"File Type\" Required=\"FALSE\" EnforceUniqueValues=\"FALSE\" Indexed=\"FALSE\" MaxLength=\"255\" ID=\"{7d522db6-c085-4161-bbff-d11a538c57a9}\" SourceID=\"{d5f89928-6c33-476d-a80c-54fcf0d57164}\" StaticName=\"File_x0020_Type0\" Name=\"File_x0020_Type0\" ColName=\"nvarchar11\" RowOrdinal=\"0\" Version=\"1\" />",
                "Scope": "/SalesForce Files",
                "Sealed": false,
                "Sortable": true,
                "StaticName": "File_x0020_Type0",
                "Title": "File Type",
                "FieldTypeKind": 2,
                "TypeAsString": "Text",
                "TypeDisplayName": "Single line of text",
                "TypeShortDescription": "Single line of text",
                "ValidationFormula": null,
                "ValidationMessage": null,
                "MaxLength": 255
            },

           . . . . . . .  .

Here as i marked in yellow:

Hidden
false  (Indicates that this field is not system defined and used for internal purpose).
Internal Name
Name of the field as defined internally by SharePoint.
Title
Title of the field.
TypeAsString
Type of the field in text.
FieldTypeKind
Refer below link for possible values:         
http://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spfieldtype.aspx               

Hope it helped you :)

Comments

Post a Comment

Popular posts from this blog

SharePoint Online (O365) OAuth Authentication | Authorizing REST API calls against SharePoint Online Site | Get Access token from SharePoint Online | Set up OAuth for SharePoint Online Office 365

-
Image
Here is my most awaited post on how to set up OAuth for SharePoint Online so that we can authorize REST API calls to the SharePoint site to retrieve data and manipulate the site data. The steps going to be easy and I will demonstrate along with screenshots and examples with the Google PostMan RESTClient . I have explained the steps below which follows the OAuth 2.0 protocol. All the steps are straight forward, but constructing the URLs are little tricky! Below are the detailed steps: 1.  Register an app in SharePoint ·          Navigate to https://your_site_name.com/_layouts/15/appregnew.aspx ·          Click Generate for Client Id and Client Secret. ·          Give a name for the app, fill in the app domain (ex: www.google.com , www.salesforce.com ). Enter the Redirect URL, important here is when entering redirect url, it should be https ...
Read more

SharePoint 2013 REST API Reference

-
Image
SharePoint 2013 introduces a Representational State Transfer (REST) interface that opens the SharePoint 2013 development platform to standard Web technologies and languages. These comparable to the existing SharePoint   client object models . Now, developers can interact remotely with SharePoint data by using any technology that supports REST web requests. This means that developers can perform   Create ,   Read ,   Update , and   Delete   (CRUD) operations from their apps for SharePoint, solutions, and client applications, using REST web technologies and standard Open Data Protocol (OData) syntax. Reference Sample REST endpoint: http://server/site/_api/lists/getbytitle('listname') the above api gets the List ‘listname’, by the method ‘getbytitle’.     Before it can do anything with SharePoint, your remote Web or mobile application must obtain authorized access. One of the approach would be using Oauth. The MSDN Library...
Read more

Simple Risk Assessment Matrix table with resultant risk calculation

-
Image
This post is not related to SharePoint and can be used in any web application with simple html and Jquery. I was preparing a risk matrix table for one of my projects and thought it is worth sharing it here. " A Risk Assessment Matrix is a project management tool that allows a quick view of the probable risks evaluated in terms of the likelihood or probability of the risk and the severity of the consequences. " . Let us build the below table. Once you have the page ready, you can calculate the resultant risk by passing the likelihood and the severity to the page using query-strings. For example your page is riskMatrix.html, then: http://mySitename/pages/riskMatrix.html?L=2&S=3 , so here Likelihood=3 and Severity=3, so the resultant risk is highlighted as M. Below is the complete code HTML, CSS and JS. Make sure you have referenced bootstrap and jquery (offline copy/CDN) in your page. <table class="table table-bordered table-responsive...
Read more

Kendo UI (Core JavaScript) grid Server Paging, Server Sorting and Server Filtering with Dynamic SQL queries

-
Image
Kendo UI (Core JavaScript)  grid Server Paging, Server Sorting and Server Filtering with Dynamic SQL queries Introduction Writing this post after a long time. Came across Kendo UI components in one of the projects. Kendo UI Grid (paid!) is one of the amazing html components from Kendo with excellent features like filtering, sorting, grouping, re-arranging, paging etc. Problem I recently came across a requirement where I had to pull data from MSSQL server and display it on a kendo grid. But it was about pulling thousands of records to the grid, which would slow down the app for the first time, but I did not want that to happen. So thought of implementing kendo Server paging which is readily available with Kendo Grid. But since I use Kendo UI core pure JavaScript framework and not the kendo wrapper for asp.net mvc etc, paging, filtering and sorting need to be handled manually by the developer. After Googling for a while, I did not find any help relevant to implementati...
Read more

Sharepoint- Using an Image From formatmap32x32.png in a Ribbon Control

-
Image
As you know in SharePoint , ribbon button images are coming from a built in image called formatmap32x32.png and formatmap16x16.png which are located at: C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\1033\IMAGES So if you are creating custom ribbon buttons, and if you want to use one of the built in button image, then how would you set Image32by32Top and Image32by32Left ? Here is the answer. Get the image from from the above path. Choose the icon image which you would like yo use. As shown below, say the icon which chose is a pie chart as marked with black outline. Count its position from top. its 7. also count its position from left, its 8.  Since the image is 32*32, you would calculate as left=32*8= 256 and Top=224. Now in your Elements.xml use this counts as: Image32by32="/_layouts/$Resources:core,Language;/images/formatmap32x32.png" Image32by32Top="-224" Image32by32Left="-256" Use the similar s...
Read more