Citrix Workspaces HTTP Methods_v1.02.pptx

Editor's Notes

• #1: CCI Talking Points: Module 4: Citrix Workspace with HTTP Methods| Total Time: <TBD> minutes 20 Slides | Lecture Time: 20 minutes 7 Labs | Lab Time: <TBD> minutes 4-1: POST – Using Postman to Add Data to SoR 4-2: POST – Using Citrix Workspace to Add Data to SoR 4-3: PUT – Using Postman to Update Data in SoR 4-4: PUT – Using Citrix Workspace to Update Data in SoR 4-5: DELETE – Using Postman to Remove Data from SoR 4-6: DELETE – Using Citrix Workspace to Remove Data from SoR 4-7: Notifications – Creating Notifications for Actions The purpose of this module is to: Give the students an understanding of the way HTTP Methods are used using API development applications POSTman and Citrix Workspace.
• #2: CCI Talking Points: [Point 1] We will the purpose of the POST method by using it in the Postman and Citrix Workspace application using an example. [Point 2] Identify how a primary key is used by looking at the data we configure in Postman and Citrix Workspace. [Point 3] Explain the purpose of the PUT methods through piggy backing off the example used for the POST method. [Point 4] Discuss how to use the DELETE method on the record we will create. Delivery Preparation:  A sign of a great instructor is his or her ability to provide meaningful overviews of the course content as it relates to both the learning trajectory of the course, and also to student experiences. In addition, this is the first chance that students will understand (short of reading the online catalog) what is and is not specifically covered in the course and module.
• #4: CCI Talking Points: Introduce the POST HTTP Method. Recall from Module 3, slide 30, that POST commands add new data to the database. Present the slides on the screen. Explain the diagram using the Key Notes. Key Notes: This method is used to create a new resource into a collection of resources in the System of Record. The HTTP POST request is used to create a new record in the data source in the RESTful architecture In order to add new data information to the server application, use the POST command in Citrix Workspace. In the database, the API docs contain the header and POST command that is needed to add the new resource to the database. Example: The client makes a HTTP POST request to add new data to the system of record. That HTTP POST request is sent through APIs, to the Server. The server authenticates the HTTP POST request and sends the response. The response is sent through the APIs and formatted in JSON to the client indicating the new data requesting to be added is successfully added.
• #5: CCI Talking Points: Talk to the bullets first, then explain the examples from the key notes. After reading the first example, recall Mod 3, lesson on Endpoint URIs to bring this point together. Key Notes: There is no data cap on the size to be sent. POST is used to send data to a server to create/update a resource. Example 1: Using POST in sequence example is saying that there is a HTTP POST request to create a new device. After the forward slash, the word devices signifies a new device is to be created. That is because the endpoint URI is describing the data to be added. Example 2: This is an example request URIs for POST HTTP requests. POST always precedes the HTTP syntax. This is saying to POST new data to the Accounts folder, under 123, under Users.
• #8: CCI Talking Points: Talk through the definition first. Then read through the functions Advise on second bullet that we are not going to go into further detail on these items, they are just to know primary keys have many functions. What this lesson goes through is primary keys in Citrix Workspace instance. Key Notes: The database is responsible for assigning a primary key to a table but is not always necessarily an ID column that is used as the primary key. It is possible to have multiple unique keys that are not primary keys. Each row is a record in the table. And each record is identified by a unique identifier, otherwise known as the primary key. What this means is if the database has two individuals by the same name, but they are not the same person, the unique identifier is what delineates the two individuals. The Primary key’s value is always unique. If the client sends an HTTP request to PUT or update a users last name, using the unique identifier, it will change the record for that specific person instead of both. Primary key is like a fingerprint. A person’s fingerprint is unique to them. Example: An update (PUT command) needs to be made to one of the records in the Systems of Record. That record we want to change looks the same as another record. Because every record in the SoR has its own primary key, this comes into play when making a change to one system of record without affecting the other record that is similar. The primary key is like a person’s fingerprint that says this record is its own record and is the one to be updated.
• #9: CCI Talking Points: Introduce the primary key. Speak to the bullets on the slide. Transition topic to continue on the HTTP methods – PUT.
• #12: CCI Talking Points Introduce the PUT method. Source Module 3, slide HTTP methods. Recall put commands are to update and replace information. Explain the diagram using the key notes. Explain the Examples using the key notes. In the first example, recall to the primary key section, slide 8 and 9 of this Module. Key Notes: Use PUT when updating a record completely through a specific resource. This could be updating a user’s email address. Diagram: The diagram illustrates the relationship between the Client, API, and the Server. The Client makes the PUT HTTP request, which is sent through the API, to the Server, then back to the Client with a response. Example 1: This example illustrates the PUT sequence and is referenced with an ID to update the device information to a specific record in the database. Example 2: This example shows how the PUT HTTP method’s syntax. This is what the Request-URI would appear like.
• #15: CCI Talking Points Introduce the Delete method. Source Module 3, slide HTTP methods: Recall that the delete command eliminates a record from the database completely when the client sends the HTTP delete request. Bring in the Endpoint URI concept when speaking to the Request URI and the example. Key Notes The HTTP DELETE command is straight forward. It is used to delete a resource identified by a URI, such as deleting a user’s name and information. On successful deletion, a response, formatted in JSON, is returned via HTTP response success message. Example 1: This example illustrates the DELETE HTTP request in sequence. This sequence says delete the device for specific ID. What specifying that ID does it make sure the system only deletes that specific piece of data in the record that is identified by that ID. Example 2: This is what the DELETE HTTP method looks like by the Request URI. This is describing the Endpoint URI, the place where the data that is being requested to be deleted, is located.
• #18: CCI Talking Points: There are 7 lab exercises in Module 4; this slide addresses all 4 of them. This Slide: 4-1 POST – Using Postman to Add Data to SoR Time: <##> minutes 4-2 POST – Using Citrix Workspace to Add Data to SoR Time: <##> minutes 4-3 PUT – Using Postman to Update Data in SoR Time: <##> minutes 4-4 PUT – Using Citrix Workspace to Update Data in SoR Time: <##> minutes 4-5 DELETE – Using Postman to Remove Data from SoR Time: <##> minutes 4-6: DELETE – Using Citrix Workspace to Remove Data from SoR Time: <##> minutes 4-7: Notifications – Creating Notifications for Actions Time: <##> minutes