Filters for Portal API Orgs
search cancel

Filters for Portal API Orgs

book

Article ID: 244190

calendar_today

Updated On:

Products

CA API Developer Portal

Issue/Introduction

Is there a filter for the portal API Organizations in order to get all the organizations whose names starts with a string?

For example: We are trying to do the following:

- GET https://<papi_host>/portal/tenant-admin/1.0/organizations?name=Org*

I have also tried with filters like:

- GET https://<papi_host>/portal/tenant-admin/1.0/organizations?$filter=startsWith(name,"Org")

- GET https://<papi_host>/portal/tenant-admin/1.0/organizations?$search=Org*

With no success can you help with this?

 

Environment

Release : 5.x

Component : API PORTAL

Resolution

https://<papi_host>/portal/tenant-admin/1.0/organizations?name=searchString  (without the * ) should return a list of orgs where name contains searchString.

Our PAPI Open API Spec needs to be updated as it should describe the full set of filters. These include:
status : one of ENABLED, DISABLED,  REGISTRATION_INIT, REGISTRATION_PENDING_APPROVAL
type : one of CONSUMER, PUBLISHER
name : returns all Orgs with a name like <value>
apiPlanUuid (a list of UUIDs) : returns all Orgs that use one of the specified API Plans
accountPlanUuid  (a list of UUIDs) : returns all Orgs that use one of the specified Account Plans
rateQuotaUuid  (a list of UUIDs): returns all Orgs that use  one of the specified Rate Quota Plans
tag (a list of tags) : returns all Orgs that have one of the specified Tags
orgId  (a list of UUIDs):  returns the set of Orgs identified by the provided UUIDs