Search contents based on criteria

1 min

GET

http://localhost:65349//api/episerver/v2.0/search/content

Query Parameters

languagesstring[]required
filterstring
Description
Specify a filter string to be applied to the search. Filter strings utilize OData v4 filter syntax
orderbystring
Description
Specify an orderby string to be applied to the search. Orderby strings utilize OData v4 sort syntax
querystring
Description
Free text search to filter content. Supports query string syntax for searching in individual fields
skipinteger
Description
Specify number of items to skip in returned search results (used for pagination)
topinteger
Description
Specify number of items to return in search results (used for pagination)
personalizeboolean
Description
Determines if returned content will be personalized (via the Visitor Group system) when returned. By default, content will be fetched in the context of an anonymous user.
expandstring
Description
Comma-separated list of reference properties (Content References, Content Areas) which should have their content fetched in the response. Passing ' * ' will load content in all reference properties in the return.

Header Parameters

acceptstring
Description
Generated from available response content types
Default
application/json
Allowed
application/jsontext/jsonapplication/xmltext/xml

Responses

200OK

SearchResponse
Description
Represents a search response sent back from the Content Api
- TotalMatchinginteger<int32>
  Description
  Total number of matching results from the search request. For use in calculating pagination on the client, this number may be bigger than the returned total of {EPiServer.ContentApi.Search.Internal.SearchResponse.Results} in a single request based on the provider {EPiServer.ContentApi.Search.Internal.SearchRequest.Top} value, as well as the {EPiServer.ContentApi.Search.ContentSearchApiOptions.MaximumSearchResults} configuration value.
  Format
  int32
- ResultsContentApiModel[]
  Description
  Search Results in the form of {EPiServer.ContentApi.Core.Serialization.Models.ContentApiModel} instances
  - ContentLinkContentModelReference
    - Idinteger<int32>
      Format
      int32
    - WorkIdinteger<int32>
      Format
      int32
    - GuidValuestring<uuid>
      Example
      00000000-0000-0000-0000-000000000000
      Format
      uuid
    - ProviderNamestring
    - Urlstring
    - LanguageLanguageModel
      - DisplayNamestring
      - Namestring
    - ExpandedContentApiModel
      - Circular-Reference
  - Namestring
  - LanguageLanguageModel
    - DisplayNamestring
    - Namestring
  - ExistingLanguagesLanguageModel[]
    - DisplayNamestring
    - Namestring
  - MasterLanguageLanguageModel
    - DisplayNamestring
    - Namestring
  - ContentTypestring[]
  - ParentLinkContentModelReference
    - Idinteger<int32>
      Format
      int32
    - WorkIdinteger<int32>
      Format
      int32
    - GuidValuestring<uuid>
      Example
      00000000-0000-0000-0000-000000000000
      Format
      uuid
    - ProviderNamestring
    - Urlstring
    - LanguageLanguageModel
      - DisplayNamestring
      - Namestring
    - ExpandedContentApiModel
      - Circular-Reference
  - RouteSegmentstring
  - Urlstring
  - Changedstring<date-time>
    Format
    date-time
  - Createdstring<date-time>
    Format
    date-time
  - StartPublishstring<date-time>
    Format
    date-time
  - StopPublishstring<date-time>
    Format
    date-time
  - Savedstring<date-time>
    Format
    date-time
  - Statusstring

400Bad Request

curl

curl --request GET \
     --url 'http://localhost:65349//api/episerver/v2.0/search/content?languages=array' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("http://localhost:65349//api/episerver/v2.0/search/content?languages=array", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("http://localhost:65349//api/episerver/v2.0/search/content?languages=array")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "http://localhost:65349//api/episerver/v2.0/search/content?languages=array"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// OK
{
  "TotalMatching": "",
  "Results": [
    {
      "ContentLink": {
        "Id": "",
        "WorkId": "",
        "GuidValue": "00000000-0000-0000-0000-000000000000",
        "ProviderName": "",
        "Url": "",
        "Language": {
          "DisplayName": "",
          "Name": ""
        },
        "Expanded": {
          "": ""
        }
      },
      "Name": "",
      "Language": {
        "DisplayName": "",
        "Name": ""
      },
      "ExistingLanguages": [
        {
          "DisplayName": "",
          "Name": ""
        }
      ],
      "MasterLanguage": {
        "DisplayName": "",
        "Name": ""
      },
      "ContentType": [
        ""
      ],
      "ParentLink": {
        "Id": "",
        "WorkId": "",
        "GuidValue": "00000000-0000-0000-0000-000000000000",
        "ProviderName": "",
        "Url": "",
        "Language": {
          "DisplayName": "",
          "Name": ""
        },
        "Expanded": {
          "": ""
        }
      },
      "RouteSegment": "",
      "Url": "",
      "Changed": "",
      "Created": "",
      "StartPublish": "",
      "StopPublish": "",
      "Saved": "",
      "Status": ""
    }
  ]
}

400

// Bad Request