| Table of Contents |
|---|
Properties of a REST API method document
...
| id | page_properties_method_REST API |
|---|
...
Document type
...
Document name
...
Guideline ID
...
Author
...
Document version
...
Document status
...
Date of creation
...
Method ID
...
Microservices (namespace)
...
MPI
...
Components
...
Link ApiAry
...
...
Resource
...
Scope
...
Protocol type
...
Request type
...
Sync/Async
...
Public/Private/Internal
Purpose
Logic
Key points
It provides important information about the main aspects of this method. It offers specific key points that are important for understanding and using this method
Input parameters
...
Input parameter
...
Values
...
Type
...
Description
...
Example
Request structure
| Expand | ||
|---|---|---|
| ||
|
Authorize
Headers
Request data validation
Dictionaries
| Page Properties Report |
|---|
Processing
Service Logic
Response structure
Example:
| Expand | ||
|---|---|---|
| ||
|
| Expand | ||
|---|---|---|
| ||
|
HTTP status codes
...
HTTP status code
...
Message
...
What caused the error
...
...
...
Technical modules where the method is used
| Page Properties Report |
|---|