Consuming Endpoints in Postman
  • 05 Apr 2023
  • 1 Minute to read
  • Dark

Consuming Endpoints in Postman

  • Dark

Article Summary

Endpoint consumption examples in Postman

Entities List (GET)

Select the Entities List collection item, then the Headers tab.

Select the Authorization value and replace the string after the word “Bearer” with either Authorization Token value or the variable that holds the value. Make sure Content-Type is set to application/json and the request type is GET.

Click Send and you should get a result in the bottom window after a few seconds.

Response Explanation

The response is a collection of objects that have the following properties:

  • EntityName:                         table name in the database
  • EntityNameDisplay:             title of table
  • AllowAdd:                             allows you to use this table in Add Endpoint
  • AllowEdit:                             allows you to use this table in Update Endpoint
  • AllowView:                            allows you to use this table in Get Endpoint
  • EntityNameForAPI:               this is the value you use in URL segment

Schema (POST)

Select the Schema, then the Headers tab. Set your values for url address and the token. Ensure POST is selected for the request type and Content-Type is set to application/json.

You will need the EntityName mentioned in the EntityList response as a URL segment (e.g.: Customers). The EntityName is prefixed with “tbl” when you query EntityList Endpoint. You must remove the “tbl” part.

You will need to adjust the URL /API2/CSSAPI/V2/EntityName/Schema

Response Explanation 

Response NameExplanation

Name in Database

Boolean that determines if it is a primary key
Boolean to determine if it is auto increment
Boolean that allows a NULL value
Data types for field
max number of characters in the field (NULL for number field)
max number of decimal places (NULL when it isn’t a number)
max number of floating points (NULL when it isn’t a number)
Boolean that indicates if it has a default value
Boolean that indicates the value is a concatenation or calculation
Boolean indicates the field stores a password

Was this article helpful?