Search repository

This Web service searches one or more repositories and returns a list of the objects that meet the search criteria, along with their property values. The search results are included in the body of the response.

HTTP method

GET

URI

/aiwservices/v1/repository/repositoryName?action=search&searchCriteria=attribute=value&limitResults=value2
  • Replace repositoryName with the name of the repository that you want to search or with * to search in all the repositories.
  • Replace attribute=value with one or more properties and their values.
    Use %27 to represent quotation marks around the values in the attribute/value pairs.

    Use AND and OR between attribute/value pairs to refine your search criteria.

    Use %20 to represent the space between the conjunction (AND or OR) and the attribute/value pair that follows it.

  • Replace value2 with the maximum number of search results to retrieve. You must include a maximum value. To return all objects that match the search criteria, use a large value such as 100000000.
    The limitResults portion of the Web service is required. If you do not include it, the Web service returns an error.

You can use any of these comparisons in the attribute/value pairs:
  • = (equal to)
    Job or document data is returned in the search results if the property value exactly matches the text in the Value field. The comparison is case-sensitive.
  • != (not equal to)
    Job or document data is returned in the search results if the property has a value and it is not the value in the Value field. The comparison is case-sensitive.
  • > (greater than)
    Job or document data is returned in the search results if the property value is greater than the number in the Value field.
  • < (less than)
    Job or document data is returned in the search results if the property value is less than the number in the Value field or if the property has no value.
  • >= (greater than or equal to)
    Job or document data is returned in the search results if the property value is the same as or greater than the number in the Value field.
  • <= (less than or equal to)
    Job or document data is returned in the search results if the property value is the same as or less than the number in the Value field or if the property has no value.
  • like
    Job or document data is returned in the search results if the property value matches the value in the Value field when wildcard characters contained in the Value field are taken into account. For example, the value in the Value field for the Job name property is CUST1*. All jobs from one customer have the prefix CUST1 added to the job name. A job meets the search option when its job name begins with the text CUST1. The comparison is case-sensitive.
  • unlike
    Job or document data is returned in the search results if the property value does not match the value in the Value field when wildcard characters contained in the Value field are taken into account. For example, the value in the Value field for the Job name property is *.pdf. A job meets the search option when the extension for the job name is not .pdf. The comparison is case-sensitive.
Keep these concepts in mind:
  • When you use the like or unlike comparison, you can use wildcard characters in the Value field. Use * or % to represent zero or more characters; use _ or ? to represent exactly one character. If you use a like comparison and type only a wildcard character in the Value field, all the jobs or documents in which that property value is set are returned in the search results, but not the jobs in which that value is Not set.
  • If the Value is a date or timestamp, make sure that the Comparison is less than (<), greater than (>).
    To include dates as values, use this format: %27YYYY-MM-DDTHH:MM:SSZ%27, where:
    • YYYY-MM-DD represents the 4–digit year, 2–digit month, and 2–digit day.
    • T marks the end of the date.
    • HH:MM:SS represents the 24–hour time.
    • Z marks the end of the time.
    • %27 represents the quotation marks around the value.

Request headers

ippdcredential

<credential token="value" />

Accept-Language (optional)

lang

Supported language values:

de German
en US English (default)
es Spanish
fr French
it Italian
ja Japanese
pt_BR Brazilian Portuguese

Return codes

  • 200 OK
  • 404 Not Found
  • 500 Internal Server Error

Example

Sample request

Search for archived objects with these values:
  • Member number (Doc.Member.Number) = 6883179219021913
  • Customer name (Job.CustomerName) = RicohSample
  • Repository = Sample
  • Maximum number of results to return = 5

http://hostname:15080/aiwservices/v1/repository/SampleRepository?action=search&searchCriteria=Doc.Member.Number=%276883179219021913%27AND%20Job.CustomerName=%27RicohSample%27&limitResults=5

 
Copyright © 2015, 2018