EP API - Reading Endpoints (GET)

The APIs in this chapters are only for reading data from the Wisefish Business Central system, so there are no parameters used.

Requesting all entries

Data is retrieved with a GET request where the URL is is combined as follows:

JSON

GET
[server]/api/wisefish/wiFiEP/v1.0/companies([CompanyGUID])/[endpoint]

Example:
To get all the origin Production Agreements exposed by the API:

CODE

https://containers.wisefish.com/BC24BjarteyW1CU1rest/api/wisefish/wiFiEP/v1.0/companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/productionAgreements

Requesting a single entry

To request a specific entry, the user must know the systemID of that particular entry.

JSON

GET
[server]/api/wisefish/wiFiEP/v1.0/companies([CompanyGUID])/[endpoint]([systemID])

Example:
To get the production agreement with system ID = d0a431bf-b8a5-ef11-b017-bd6349c859ee:

CODE

https://containers.wisefish.com/BC24BjarteyW1CU1rest/api/wisefish/wiFiEP/v1.0/companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/productionAgreements(d0a431bf-b8a5-ef11-b017-bd6349c859ee)

Show child entries

For some APIs there are child entries. To make them visible in the response, the expand URL parameter must be used:

JSON

GET
[server]/api/wisefish/wiFiEP/v1.0/companies([CompanyGUID])/[endpoint]([systemID])?$expand=[detailsAPI]

Example:
To get the production agreement with system ID = d0a431bf-b8a5-ef11-b017-bd6349c859ee:

CODE

https://containers.wisefish.com/BC24BjarteyW1CU1rest/api/wisefish/wiFiEP/v1.0/companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/
                    productionAgreements(d0a431bf-b8a5-ef11-b017-bd6349c859ee)?$expand=productionAgreementLines

Response

The data is returned as JSON. See example on the documentation page for each API endpoint.

Filtering

A filter is added with $filter. An example of how a filter is added:

NONE

https://containers.wisefish.com/BC24BjarteyW1CU1rest/api/wisefish/wiFiEP/v1.0/companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/itemUnitOfMeasures?$filter=itemNo eq '70070'