Api Home > ServiceCatalog > Search

GET api/teams/ServiceCatalog/Search?searchText={searchText}&searchType={searchType}&skipCount={skipCount}&takeCount={takeCount} Search the service catalog by type of RO and text.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
searchText

Text to search on

string

Required

searchType

String, values can be "Incidents", "Requests", "Favorites", or "All"

string

Required

skipCount

Default to 0, calculated automatically based of results already returned

integer

Default value is 0

takeCount

For pagination / infinite-scroll. Integer number of results to return per page

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

Collection of ServiceCatalogSearchResult
NameDescriptionTypeAdditional information
Id

string

None.

Title

string

None.

Description

string

None.

Popularity

integer

None.

ServiceOfferingId

string

None.

IsFavorite

boolean

None.

IsAdvancedRequestOffering

boolean

None.

RequestOfferingLinkUrl

string

None.

RequestOfferingLinkTargetType

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "sample string 1",
    "Title": "sample string 2",
    "Description": "sample string 3",
    "Popularity": 4,
    "ServiceOfferingId": "sample string 5",
    "IsFavorite": true,
    "IsAdvancedRequestOffering": true,
    "RequestOfferingLinkUrl": "sample string 8",
    "RequestOfferingLinkTargetType": "sample string 9"
  },
  {
    "Id": "sample string 1",
    "Title": "sample string 2",
    "Description": "sample string 3",
    "Popularity": 4,
    "ServiceOfferingId": "sample string 5",
    "IsFavorite": true,
    "IsAdvancedRequestOffering": true,
    "RequestOfferingLinkUrl": "sample string 8",
    "RequestOfferingLinkTargetType": "sample string 9"
  }
]

application/xml, text/xml

Sample:
<ArrayOfServiceCatalogSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.WebConsole.ViewModels">
  <ServiceCatalogSearchResult>
    <Description>sample string 3</Description>
    <Id>sample string 1</Id>
    <IsAdvancedRequestOffering>true</IsAdvancedRequestOffering>
    <IsFavorite>true</IsFavorite>
    <Popularity>4</Popularity>
    <RequestOfferingLinkTargetType>sample string 9</RequestOfferingLinkTargetType>
    <RequestOfferingLinkUrl>sample string 8</RequestOfferingLinkUrl>
    <ServiceOfferingId>sample string 5</ServiceOfferingId>
    <Title>sample string 2</Title>
  </ServiceCatalogSearchResult>
  <ServiceCatalogSearchResult>
    <Description>sample string 3</Description>
    <Id>sample string 1</Id>
    <IsAdvancedRequestOffering>true</IsAdvancedRequestOffering>
    <IsFavorite>true</IsFavorite>
    <Popularity>4</Popularity>
    <RequestOfferingLinkTargetType>sample string 9</RequestOfferingLinkTargetType>
    <RequestOfferingLinkUrl>sample string 8</RequestOfferingLinkUrl>
    <ServiceOfferingId>sample string 5</ServiceOfferingId>
    <Title>sample string 2</Title>
  </ServiceCatalogSearchResult>
</ArrayOfServiceCatalogSearchResult>