Orchard Web Services: Search

Search is a simplified interface to search against Orchard data

Browse

Browse calls issue a MATCHALL search across Orchard data and allow

GET /api/v1/browse?context={context}&token={token}&page={page}&page_size={page_size}&filter.field_name={filter_value}&sort={sort}
  • Parameters
  • context
    (required) string
    token
    (required) string
    page
    number
    page_size
    number
    filter_value
    string
    sort
    string
  • Response 200 SHOW
  • < Content-Type: application/json
            {
            "sample": "Sample!"
        }

Suggest

Suggest Calls run a prefix query against Orchard data

GET /api/v1/suggest?term={term}&context={context}&token={token}
  • Parameters
  • term
    (required) string
    context
    (required) string
    token
    (required) string
  • Response 200 SHOW
  • < Content-Type: application/json
            {
            "sample": "Sample!"
        }

Item

Item calls return a single resource by id

GET /api/v1/item/{item_type}/{id}?context={context}&token={token}
  • Parameters
  • item_type
    (required) string
    id
    (required) number
    context
    (required) string
    token
    (required) string
  • Response 200 SHOW
  • < Content-Type: application/json
            {
            "sample": "Sample!"
        }