Documentation

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

Entity API / getSuppliers

Operation Information

  • Application Reference: com.hornbill.suppliermanager
  • Scope: Entity - Suppliers
  • Class: Entity
  • Required Privilege Level: guest
  • Required Rights: Group A - canViewSuppliers

Description

This flowcode operation gets details of all suppliers based on the search criteria provided.

Request Parameters

The getSuppliers API takes the following input parameters. It is important to note that the parameters must satisfy the requirement of the input validation checks.

Name Type Required Description
searchFilter xs:string No Search criteria for suppliers.
filterByStatus xs:string No Filters the results by status. Allowable values are status.pipeline, status.active, status.archived
filterBySupplierStatus xs:string No Filters the results by supplier status. Allowable values come from the simple list 'Supplier Status'
filterByOwner xs:string No Filters the results by supplier owner (user id)
filterByRating xs:string No Filters the results by supplier rating Allowable values are 1, 2, 3, 4, 5, >=2, >=3, >=4, <=2, <=3, <=4
filterByApplication xs:string No Filters the results by application. For example, to return all suppliers that are available in Hornbill Service Manager 'com.hornbill.servicemanager'
filterByAssets xs:string No Filters the results by associated assets. Accepts an array of asset id's
rowStart xs:integer Yes Row Start for Paging.
rowLimit xs:integer Yes Page Size.

Response Parameters

Name Type Description
outcome xs:string The outcome of the flowcode operation.
totalRecordCount xs:integer The total number of suppliers that match the search criteria.
suppliers xs:string A JSON string of suppliers.
supplierOwners xs:string A JSON string of unique supplier owners for all suppliers that the user invoking the operation has access to.
test xs:string Testing

Code Examples

In This Document