Restful APIs [DOCUMENT TITLE] - Riversand Technologies€¦ · Restful APIs course is designed to...

5
[COMPANY NAME] [Company address] [DOCUMENT TITLE] Restful APIs RDP-25-AP Course Overview For Public Domain

Transcript of Restful APIs [DOCUMENT TITLE] - Riversand Technologies€¦ · Restful APIs course is designed to...

Page 1: Restful APIs [DOCUMENT TITLE] - Riversand Technologies€¦ · Restful APIs course is designed to explain about the operations of Riversand RESTful API services and how to perform

© Riversand Technologies Inc.

0

[COMPANY NAME] [Company address]

[DOCUMENT TITLE]

Restful APIs RDP-25-AP Course Overview

For Public Domain

Page 2: Restful APIs [DOCUMENT TITLE] - Riversand Technologies€¦ · Restful APIs course is designed to explain about the operations of Riversand RESTful API services and how to perform

© Riversand Technologies Inc.

1

Contents Course Overview ........................................................................................................................ 2

Objectives .................................................................................................................................. 2

Target Audience ......................................................................................................................... 2

Prerequisites .............................................................................................................................. 2

Duration ..................................................................................................................................... 3

Agenda ....................................................................................................................................... 3

Module 1: UI Configuration Concepts ............................................................................................................ 3

Module 2: UI Configuration Exercises............................................................................................................. 3

Page 3: Restful APIs [DOCUMENT TITLE] - Riversand Technologies€¦ · Restful APIs course is designed to explain about the operations of Riversand RESTful API services and how to perform

© Riversand Technologies Inc.

2

Restful APIs

Course Overview Riversand Platform exposes various RESTful APIs that enables you to manage data efficiently as per the business requirement. To use these APIs, your application must use https to authenticate the request. It is mandatory to only use https for API access,

Restful APIs course is designed to explain about the operations of Riversand RESTful API services and how to perform various queries using Postman application.

Note that this course is designed with Tell me, Show me and Try me learning formats, so that you get the maximum benefits.

Objectives After successfully completing this course, you should be able to:

• Understand Riversand Restful APIs

• Query Requests and Responses of various API services

Target Audience

• System / IT Administrators

• Implementation Consultants

• Technical Developers / Pre-Sales / Support

Prerequisites To proceed with Restful APIs, you are expected to complete the following courses:

• GEN-01-RDP – Introduction to Riversand Platform

• RDP-25 – Basic App Configurations

• Additionally, a. Install software such as Postman, Chrome browser, and Visual Studio Code on your local b. Good understanding of Riversand Platform Architecture and Apps c. Good understanding of Git basics, Git file naming conventions, project Git directory structure

Page 4: Restful APIs [DOCUMENT TITLE] - Riversand Technologies€¦ · Restful APIs course is designed to explain about the operations of Riversand RESTful API services and how to perform

© Riversand Technologies Inc.

3

d. Good understanding of Postman usage and Riversand APIs Get operations

Duration The course duration is 120 minutes.

Agenda

Module 1: UI Configuration Concepts

• General understanding of API, HTTP methods, and Postman operation

• Understand various Riversand RESTful API services, HTTPs Requests, JSON structure, and how to perform various queries using Postman application

Module 2: UI Configuration Exercises

Know about the following services and its business scenario to practice

• Entity App Service o Create entity using RESTful API o Query request to create an entity with self-relationship o Query request to create an entity with self and context attribute

• Entity App Service – Get entities by specifying fields and entity ID

• Entity App Service – Update o Entity update query request o Delete attribute values using update method

• Entity App Service - Delete an entity using delete method

• Entity App Model Service o Get all entity types for a specific domain o Get model info using model type and ID o Get all users or roles in tenant

• Entity Govern Service o Get govern data o Get business condition status of an entity o Start workflow

• Configuration Service o Get configuration data using ID

• Authorization Service o Compute authorization model

Page 5: Restful APIs [DOCUMENT TITLE] - Riversand Technologies€¦ · Restful APIs course is designed to explain about the operations of Riversand RESTful API services and how to perform

© Riversand Technologies Inc.

4

• Bulk Edit Service o Process bulk entities

• Entity Graph Service o Get graph process model o Roll up sku to product / Roll down product to SKU o Link SKU to Image/Image to SKU -Query Request