Reading Resources

Most TIBCO Scribe® API resources support GET requests, as either a query or a fetch operation. For all TIBCO Scribe® GET methods that return more than one item, the response headers include a Total-count field specifying the total number of items returned.

Query

Query operations:

• Return a collection of 1 to 500 instances of the requested resource, for example:

GET https://api.scribesoft.com/v1/orgs/12345678/solutions

• Support paging to return result sets larger than 500 records.

Paging is performed by calling a series of related methods using the Offset and Limit parameters. The Offset parameter sets the starting record and can be set between 0 and 500. An Offset value of 0 (default) makes the first record the starting record. The Limit parameter sets the number of records each method is to return. A Limit value of 100 (default) makes the 100th record the ending record. To return a large set of records, call a series of methods that increment the Offset value by the Limit value until the number of records returned is less than the Limit value. For example, the following series of calls returns up to the first 300 records:

Some query operations also support additional parameters that allow the result set to be filtered. For example, the following returns the Solution named TestSolution:

Fetch

Fetch operations typically take no additional parameters and return a single item based on the unique identifier that is supplied. For example, the following returns the Solution with the ID ec312f57-c4ab-46fb-b109-8c0740b7bc0d.

See

API Basics