You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

Introduction

OAS documents come with API endpoints that can be comprised of either the POST, GET, PUT and DELETE HTTP methods.

Properties configuration

POST

Parameters:

NameDescription
NameName of the POST API endpoint.
DescriptionA description of the POST API endpoint.
Request Body Input Type
Payload
  • Request Body 
Input FIelds
  • Field Label
  • Default Value
  • Mode
    • Default 
    • Force Mandatory 
    • Hide Field

GET

Parameters:  

NameDescription
NameName of the GET API endpoint. 
DescriptionA description of the GET API endpoint.
Field LabelSpecify a field label.
Default ValueSpecify a default value.
Mode
  • Default
  • Force Mandatory
  • Hide Field

PUT

Parameters:  

  • Name: Name of the PUT API endpoint.
  • Description: A description of the PUT API endpoint.
  • Request Body Input Type: 
    • Payload:
      • Request Body
    • Input FIelds:
      • Field Label
      • Default Value
      • Mode: 
        • Default
        • Force Mandatory
        • Hide Field
NameDescription
NameName of the PUT API endpoint.
DescriptionA description of the PUT API endpoint.
Request Body Input Type
Payload
  • Request Body 
Input FIelds
  • Field Label
  • Default Value
  • Mode
    • Default 
    • Force Mandatory 
    • Hide Field

SET

Parameters: 

NameDescription
NameName of the SET API endpoint. 
DescriptionA description of the SET API endpoint.
Field LabelSpecify a field label.
Default ValueSpecify a default value.
Mode
  • Default
  • Force Mandatory
  • Hide Field
  • No labels