---
title: "Consuming Endpoints in Postman"
slug: "consuming-endpoints-in-postman"
updated: 2023-10-12T13:37:56Z
published: 2023-10-12T13:37:56Z
canonical: "wiki.cobblestonesoftware.com/consuming-endpoints-in-postman"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://wiki.cobblestonesoftware.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Consuming Endpoints in Postman

## Endpoint consumption examples in Postman

#### Entities List (GET)

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

![](https://cdn.document360.io/e3626857-1fb5-4e27-b278-2d3fc5508be4/Images/Documentation/image-1667405487425.png)

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.

![](https://cdn.document360.io/e3626857-1fb5-4e27-b278-2d3fc5508be4/Images/Documentation/image-1667405506674.png)

#### 

#### 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.

![](https://cdn.document360.io/e3626857-1fb5-4e27-b278-2d3fc5508be4/Images/Documentation/image-1667405577598.png)

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

![](https://cdn.document360.io/e3626857-1fb5-4e27-b278-2d3fc5508be4/Images/Documentation/image-1669058099584.png)

#### Response Explanation

| **Response Name** | **Explanation** |
| --- | --- |
| **Name** | #### Name in Database |
| **IsPrimaryKey** | Boolean that determines if it is a primary key |
| IsIdentity | Boolean to determine if it is auto increment |
| IsNullable | Boolean that allows a NULL value |
| DBType | Data types for field |
| MaxLength | max number of characters in the field (NULL for number field) |
| DataPrecision | max number of decimal places (NULL when it isn’t a number) |
| DataScale | max number of floating points (NULL when it isn’t a number) |
| HasDefaultValue | Boolean that indicates if it has a default value |
| IsComputedColumn | Boolean that indicates the value is a concatenation or calculation |
| IsPassword | Boolean indicates the field stores a password |

####