Body Parameters

When doing a POST API request method, it requires user to fill out the Body Parameters section to be filled out, this is how to do so

GraphQL

GraphQL is a type of query language and server-side runtime for APIs. It prioritizes giving clients exactly the data they request and no more, making APIs fast, flexible, and developer friendly. Is not tied to any specific database or storage engine and is backed by existing code and data.

Body:

  • Input Field Type: Text Field

  • Description: This field allows the user to specify a unique name for the Custom API.

  • Usage: Enter a concise and descriptive name that succinctly identifies the API within the system. This name should facilitate easy recognition and differentiation among multiple APIs.

Parameter Name:

  • Input Field Type: Text Field

  • Description: This field allows the user to define a unique name for the Custom API.

  • Usage: Enter a concise and descriptive name that succinctly identifies the API within the system. This name should facilitate easy recognition and differentiation among multiple APIs.

Value:

  • Input Field Type: Text Field

  • Description: This field allows the user to specify a unique name for the Custom API.

  • Usage: Enter a concise and descriptive name that succinctly identifies the API within the system. This name should facilitate easy recognition and differentiation among multiple APIs.

Description:

  • Input Field Type: Text Field

  • Description: This field allows the user to specify a unique name for the Custom API.

  • Usage: Enter a concise and descriptive name that succinctly identifies the API within the system. This name should facilitate easy recognition and differentiation among multiple APIs.

Required:

  • Input Field Type: Check Box

  • Description: This field allows the user to specify a unique name for the Custom API.

  • Usage: Enter a concise and descriptive name that succinctly identifies the API within the system. This name should facilitate easy recognition and differentiation among multiple APIs.


JSON

Body:

  • Input Field Type: Text Field

  • Description: This field allows the user to specify a unique name for the Custom API.

  • Usage: Enter a concise and descriptive name that succinctly identifies the API within the system. This name should facilitate easy recognition and differentiation among multiple APIs.

Parameter Name:

  • Input Field Type: Text Field

  • Description: This field allows the user to specify a unique name for the Custom API.

  • Usage: Enter a concise and descriptive name that succinctly identifies the API within the system. This name should facilitate easy recognition and differentiation among multiple APIs.

Value:

  • Input Field Type: Text Field

  • Description: This field allows the user to specify a unique name for the Custom API.

  • Usage: Enter a concise and descriptive name that succinctly identifies the API within the system. This name should facilitate easy recognition and differentiation among multiple APIs.

Description:

  • Input Field Type: Text Field

  • Description: This field allows the user to specify a unique name for the Custom API.

  • Usage: Enter a concise and descriptive name that succinctly identifies the API within the system. This name should facilitate easy recognition and differentiation among multiple APIs.

    Required:

    • Input Field Type: Check Box

    • Description: This field allows the user to specify a unique name for the Custom API.

    • Usage: Enter a concise and descriptive name that succinctly identifies the API within the system. This name should facilitate easy recognition and differentiation among multiple APIs.

Last updated