Giter Club home page Giter Club logo

project-add-in-rest-basicdataoperations's Introduction

Basic CRUD operations in Project add-ins using the REST APIs

Use the Project REST endpoints to perform create, read, update, and delete operations onprojects from a Project Add-in.

Applies to

  • Project Online and on-premise Project 2013 and later

Using the add-in

  1. Update the PWA site in the Project-Add-in-REST-OData-BasicDataOperations Project
  2. Update the login/password to your PWA site.
  3. Run the app

Prerequisites

To use this code sample, you need the following:

  • PWA Site (Project Online, Project Server 2013 or Project Server 2016)
  • Visual Studio 2013 or later

How the sample affects your tenant data

This sample runs CSOM methods that create, edit the project name and delete projects in the PWA instance for the specified user.

Additional resources

Copyright

Copyright (c) 2016 Microsoft. All rights reserved.


Prerequisites

This sample requires the following:

Description of the code

The code that uses the REST APIs is located in the Default.aspx.cs file of the SharePoint-Add-in-REST-OData-BasicDataOperationsWeb project. The Default.aspx page of the add-in appears after you install and launch the add-in and looks similar to the following.

The add-in start page with a table listing all the list on the site by name and ID.

The sample demonstrates the following:

  • How to read and write data to and from a SharePoint host web. This data conforms with the OData protocol to the REST endpoints where the list and list item entities are exposed.

  • How to parse Atom-formatted XML returned from these endpoints and how to construct JSON-formatted representations of the list and list item entities so that you can perform Create and Update operations on them.

  • Best practices for retrieving form digest and eTag values that are required for Create and Update operations on lists and list items.

To use the sample

  1. Open Visual Studio as an administrator.
  2. Open the .sln file.
  3. In Solution Explorer, highlight the SharePoint add-in project and replace the Site URL property with the URL of your SharePoint developer site.
  4. Press F5.
  5. After the add-in installs, the consent page opens. Click Trust It.
  6. Enter a string in the text box beside the Add List button and click the button. In a moment, the page refreshes and the new list is in the table.
  7. Click the ID of the list, and then click Retrieve List Items. There will initially be no items on the list. Some additional buttons will appear.
  8. Add a string to the text box beside the Add Item button and press the button. The new item will appear in the table in the row for the list.
  9. Add a string to the text box beside the Change List Title button and press the button. The title will change in the table.
  10. Press the Delete the List button and the list is deleted.

Do not delete any of the built-in SharePoint lists. If you mistakenly do so, recover the list from the SharePoint Recycle Bin.

Troubleshooting

Problem Solution
Visual Studio does not open the browser after you press the F5 key. Set the SharePoint Add-in project as the startup project.
HTTP error 405 Method not allowed. Locate the applicationhost.config file in %userprofile%\Documents\IISExpress\config.

Locate the handler entry for StaticFile, and add the verbs GET, HEAD, POST, DEBUG, and TRACE.

Questions and comments

We'd love to get your feedback on this sample. You can send your questions and suggestions to us in the Issues section of this repository.

## Additional resources

Get to know the SharePoint 2013 REST service.

Open Data Protocol

OData: JavaScript Object Notation (JSON) Format

OData: AtomPub Format.

Copyright

Copyright (c) Microsoft. All rights reserved.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

project-add-in-rest-basicdataoperations's People

Contributors

davidchesnut avatar lindalu-msft avatar nadinmerali avatar o365devx avatar supernova-eng avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

project-add-in-rest-basicdataoperations's Issues

jsonPayload returns null

This sample add-in successfully installed on project online 'https:/sites/pwa' url'. However "ProjectServer/Projects" returns null.

`

        String jsonPayload = GetReSTRequest(sharepointUrl, "ProjectServer/Projects");
        var serializer = new JavaScriptSerializer();
        var jsonObject = serializer.DeserializeObject(jsonPayload) as Dictionary<string, object>;
   `

Can anyone help?

MFA

Any thoughts on how to write CSOM/PSI code with MFA authentication

Site url disabled

Hi ,
I downloaded the code and try to use it but I cannot add site url in project that mentioned in description. The ssl and Url field is disabled in project property window.

[Action Needed] This repo is inactive

This GitHub repository has been identified as a candidate for archival

This repository has had no activity for more than 2 years. Long periods of inactivity present security and code hygiene risks. Archiving will not prevent users from viewing or forking the code. A banner will appear on the repository alerting users that the repository is archived.

Please see https://aka.ms/sunsetting-faq to learn more about this process.

Action

✍️

❗**If this repository is still actively maintained, please simply close this issue. Closing an issue on a repository is considered activity and the repository will not be archived.🔒

If you take no action, this repository is still inactive 30 days from today it will be automatically archived..

Need more help? 🖐️

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.