Searching contents of a specific view is achieved via a HTTP GET request to the URI of the view along with the search parameter.

At this time, Accompa REST API allows searches only against "Last Updated Time" and "Created Time" attributes of records. For searching against other attributes, please create a view in Accompa first - and then read the contents of that view using the Accompa API request for "Read View".

GET /re/view/{id}/search?last_updated_time>{time}

Returns list of requirements in a specific view, which were last updated after a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC).

GET /re/view/{id}/search?last_updated_time<{time}

Returns list of requirements in a specific view, which were last updated before a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC).

GET /re/view/{id}/search?created_time>{time}

Returns list of requirements in a specific view, which were created after a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC).

GET /re/view/{id}/search?created_time<{time}

Returns list of requirements in a specific view, which were created before a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC).

GET /re/view/{id}/search?deleted_time>{time}

Returns list of requirements in a specific view, which were deleted after a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC).

GET /re/view/{id}/search?deleted_time<{time}

Returns list of requirements in a specific view, which were deleted before a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC).

GET /re/view/{id}/search?last_updated_by={user_id}

Returns list of requirements in a specific view, which were last updated by a specific user.
{id} is the integer ID of the view. {user_id} is the integer ID of the user.

GET /re/view/{id}/search?created_by={user_id}

Returns list of requirements in a specific view, which were created by a specific user.
{id} is the integer ID of the view. {user_id} is the integer ID of the user.

GET /re/view/{id}/search?{field_name}={value}

Returns list of requirements in a specific view, which meet the criteria defined using {field_name}={value}.
Searches are only supported against two field types:
1) {field_name} must be content of <name> element in the API response for GET /re/field - for which <type> element contains "Picklist". {value} must be an integer contained in a <value> element in the API response for GET /re/field - corresponding to the same field.
2) {field_name} must be content of <name> element in the API response for GET /re/field - for which <type> element contains "Textbox". {value} must be alphanumeric, no special characters are allowed at this time.

Multiple Criteria: You can combine multiple search criteria using "&" character.
Example: /search?created_time>{time}&created_by={user_id}

Availability: Available in Accompa API version "2" and later (Learn more about API versions).

RESPONSE

Status: 200 

<view>

  <requirement>

    <id>152</id>

    <id_prefix>RE-</id_prefix>

    <title>Test requirement for API</title>

    <version_number>7</version_number>

    <created_time unit="GMT Timestamp">1262493473</created_time>

    <last_updated_time unit="GMT Timestamp">1270683387</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </requirement>

  <requirement>

    <id>12</id>

    <id_prefix>RE-</id_prefix>

    <title>Export to CSV file</title>

    <version_number>6</version_number>

    <created_time unit="GMT Timestamp">1272493468</created_time>

    <last_updated_time unit="GMT Timestamp">1278683382</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </requirement>

  <requirement>

    <id>39</id>

    <id_prefix>RE-</id_prefix>

    <title>Save as PDF file</title>

    <version_number>14</version_number>

    <created_time unit="GMT Timestamp">1263493435</created_time>

    <last_updated_time unit="GMT Timestamp">1270583372</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </requirement>

  ...

</view>

If a view with ID matching {id} exists, an XML response will be generated along with the status code "200". The XML response will contain the list of requirements in that particular view which meet the search criteria, as shown above.

If a view with ID matching {id} does not exist, the response HTTP 404 "not found" will be returned. Other errors will return a response other than "200", usually along with an error message in XML format.

Search Contents of a Specific View (Containing Features)

GET /ft/view/{id}/search?last_updated_time>{time}

Returns list of features in a specific view, which were last updated after a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC).

GET /ft/view/{id}/search?last_updated_time<{time}

Returns list of features in a specific view, which were last updated before a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC).

GET /ft/view/{id}/search?created_time>{time}

Returns list of features in a specific view, which were created after a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC).

GET /ft/view/{id}/search?created_time<{time}

Returns list of features in a specific view, which were created before a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC).

GET /ft/view/{id}/search?deleted_time>{time}

Returns list of features in a specific view, which were deleted after a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC).

GET /ft/view/{id}/search?deleted_time<{time}

Returns list of features in a specific view, which were deleted before a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC).

GET /ft/view/{id}/search?last_updated_by={user_id}

Returns list of features in a specific view, which were last updated by a specific user.
{id} is the integer ID of the view. {user_id} is the integer ID of the user.

GET /ft/view/{id}/search?created_by={user_id}

Returns list of features in a specific view, which were created by a specific user.
{id} is the integer ID of the view. {user_id} is the integer ID of the user.

GET /ft/view/{id}/search?{field_name}={value}

Returns list of features in a specific view, which meet the criteria defined using {field_name}={value}.
Searches are only supported against two field types:
1) {field_name} must be content of <name> element in the API response for GET /ft/field - for which <type> element contains "Picklist". {value} must be an integer contained in a <value> element in the API response for GET /ft/field- corresponding to the same field.
2) {field_name} must be content of <name> element in the API response for GET /ft/field - for which <type> element contains "Textbox". {value} must be alphanumeric, no special characters are allowed at this time.

Multiple Criteria: You can combine multiple search criteria using "&" character.
Example: /search?created_time>{time}&created_by={user_id}

Availability: Available in Accompa API version "2" and later (Learn more about API versions).

RESPONSE

Status: 200 

<view>

  <feature>

    <id>152</id>

    <id_prefix>FT-</id_prefix>

    <title>Test feature for API</title>

    <version_number>7</version_number>

    <created_time unit="GMT Timestamp">1262493473</created_time>

    <last_updated_time unit="GMT Timestamp">1270683387</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </feature>

  <feature>

    <id>12</id>

    <id_prefix>FT-</id_prefix>

    <title>Export to CSV file</title>

    <version_number>6</version_number>

    <created_time unit="GMT Timestamp">1272493434</created_time>

    <last_updated_time unit="GMT Timestamp">1278683355</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </feature>

  <feature>

    <id>39</id>

    <id_prefix>FT-</id_prefix>

    <title>Save as PDF file</title>

    <version_number>14</version_number>

    <created_time unit="GMT Timestamp">1263493431</created_time>

    <last_updated_time unit="GMT Timestamp">1270583341</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </feature>

  ...

</view>

If a view with ID matching {id} exists, an XML response will be generated along with the status code "200". The XML response will contain the list of features in that particular view which meet the search criteria, as shown above.

If a view with ID matching {id} does not exist, the response HTTP 404 "not found" will be returned. Other errors will return a response other than "200", usually along with an error message in XML format.

Search Contents of a Specific View (Containing Use Cases)

GET /uc/view/{id}/search?last_updated_time>{time}

Returns list of use cases in a specific view, which were last updated after a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC).

GET /uc/view/{id}/search?last_updated_time<{time}

Returns list of use cases in a specific view, which were last updated before a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC).

GET /uc/view/{id}/search?created_time>{time}

Returns list of use cases in a specific view, which were created after a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC).

GET /uc/view/{id}/search?created_time<{time}

Returns list of use cases in a specific view, which were created before a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC).

GET /uc/view/{id}/search?deleted_time>{time}

Returns list of use cases in a specific view, which were deleted after a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC).

GET /uc/view/{id}/search?deleted_time<{time}

Returns list of use cases in a specific view, which were deleted before a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC).

GET /uc/view/{id}/search?last_updated_by={user_id}

Returns list of use cases in a specific view, which were last updated by a specific user.
{id} is the integer ID of the view. {user_id} is the integer ID of the user.

GET /uc/view/{id}/search?created_by={user_id}

Returns list of use cases in a specific view, which were created by a specific user.
{id} is the integer ID of the view. {user_id} is the integer ID of the user.

GET /uc/view/{id}/search?{field_name}={value}

Returns list of use cases in a specific view, which meet the criteria defined using {field_name}={value}.
Searches are only supported against two field types:
1) {field_name} must be content of <name> element in the API response for GET /uc/field - for which <type> element contains "Picklist". {value} must be an integer contained in a <value> element in the API response for GET /uc/field- corresponding to the same field.
2) {field_name} must be content of <name> element in the API response for GET /uc/field - for which <type> element contains "Textbox". {value} must be alphanumeric, no special characters are allowed at this time.

Multiple Criteria: You can combine multiple search criteria using "&" character.
Example: /search?created_time>{time}&created_by={user_id}

Availability: Available in Accompa API version "2" and later (Learn more about API versions).

RESPONSE

Status: 200 

<view>

  <use_case>

    <id>152</id>

    <id_prefix>UC-</id_prefix>

    <title>Test use case for API</title>

    <version_number>7</version_number>

    <created_time unit="GMT Timestamp">1262493473</created_time>

    <last_updated_time unit="GMT Timestamp">1270683387</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </use_case>

  <use_case>

    <id>12</id>

    <id_prefix>UC-</id_prefix>

    <title>Export to CSV file</title>

    <version_number>6</version_number>

    <created_time unit="GMT Timestamp">1272493447</created_time>

    <last_updated_time unit="GMT Timestamp">1278683392</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </use_case>

  <use_case>

    <id>39</id>

    <id_prefix>UC-</id_prefix>

    <title>Save as PDF file</title>

    <version_number>14</version_number>

    <created_time unit="GMT Timestamp">1263493441</created_time>

    <last_updated_time unit="GMT Timestamp">1270583332</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </use_case>

  ...

</view>

If a view with ID matching {id} exists, an XML response will be generated along with the status code "200". The XML response will contain the list of use cases in that particular view which meet the search criteria, as shown above.

If a view with ID matching {id} does not exist, the response HTTP 404 "not found" will be returned. Other errors will return a response other than "200", usually along with an error message in XML format.

Search Contents of a Specific View (for a Custom Object)

GET /{api_prefix}/view/{id}/search?last_updated_time>{time}

Returns list of records in a specific view of a Custom Object, which were last updated after a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC). {api_prefix} is the value of the <api_prefix> element in the API response to GET /object API request.

GET /{api_prefix}/view/{id}/search?last_updated_time<{time}

Returns list of records in a specific view of a Custom Object, which were last updated before a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC). {api_prefix} is the value of the <api_prefix> element in the API response to GET /object API request.

GET /{api_prefix}/view/{id}/search?created_time>{time}

Returns list of records in a specific view of a Custom Object, which were created after a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC). {api_prefix} is the value of the <api_prefix> element in the API response to GET /object API request.

GET /{api_prefix}/view/{id}/search?created_time<{time}

Returns list of records in a specific view of a Custom Object, which were created before a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC). {api_prefix} is the value of the <api_prefix> element in the API response to GET /object API request.

GET /{api_prefix}/view/{id}/search?deleted_time>{time}

Returns list of records in a specific view of a Custom Object, which were deleted after a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC). {api_prefix} is the value of the <api_prefix> element in the API response to GET /object API request.

GET /{api_prefix}/view/{id}/search?deleted_time<{time}

Returns list of records in a specific view of a Custom Object, which were deleted before a specific time.
{id} is the integer ID of the view. {time} is the 10-digit integer UNIX timestamp (UTC). {api_prefix} is the value of the <api_prefix> element in the API response to GET /object API request.

GET /{api_prefix}/view/{id}/search?last_updated_by={user_id}

Returns list of records in a specific view of a Custom Object, which were last updated by a specific user.
{id} is the integer ID of the view. {user_id} is the integer ID of the user. {api_prefix} is the value of the <api_prefix> element in the API response to GET /object API request.

GET /{api_prefix}/view/{id}/search?created_by={user_id}

Returns list of records in a specific view of a Custom Object, which were created by a specific user.
{id} is the integer ID of the view. {user_id} is the integer ID of the user. {api_prefix} is the value of the <api_prefix> element in the API response to GET /object API request.

GET /{api_prefix}/view/{id}/search?{field_name}={value}

Returns list of records in a specific view of a Custom Object, which meet the criteria defined using {field_name}={value}.
{api_prefix} is the value of the <api_prefix> element in the API response to GET /object API request.
Searches are only supported against two field types:
1) {field_name} must be content of <name> element in the API response for GET /{api_prefix}/field - for which <type> element contains "Picklist". {value} must be an integer contained in a <value> element in the API response for GET /{api_prefix}/field- corresponding to the same field.
2) {field_name} must be content of <name> element in the API response for GET /{api_prefix}/field - for which <type> element contains "Textbox". {value} must be alphanumeric, no special characters are allowed at this time.

Multiple Criteria: You can combine multiple search criteria using "&" character.
Example: /search?created_time>{time}&created_by={user_id}

Availability: Available in Accompa API version "2" and later (Learn more about API versions).

RESPONSE

Status: 200 

<view>

  <custom_object>

    <id>152</id>

    <id_prefix>CO-</id_prefix>

    <title>Test task for API</title>

    <version_number>7</version_number>

    <created_time unit="GMT Timestamp">1262493473</created_time>

    <last_updated_time unit="GMT Timestamp">1270683387</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </custom_object>

  <custom_object>

    <id>12</id>

    <id_prefix>CO-</id_prefix>

    <title>Export to CSV file</title>

    <version_number>6</version_number>

    <created_time unit="GMT Timestamp">1272493447</created_time>

    <last_updated_time unit="GMT Timestamp">1278683392</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </custom_object>

  <custom_object>

    <id>39</id>

    <id_prefix>CO-</id_prefix>

    <title>Save as PDF file</title>

    <version_number>14</version_number>

    <created_time unit="GMT Timestamp">1263493441</created_time>

    <last_updated_time unit="GMT Timestamp">1270583332</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </custom_object>

  ...

</view>

Search All Records (for Requirements)

Searching all requirements is achieved via a HTTP GET request along with the search parameter.

At this time, Accompa REST API allows searches only against "Last Updated Time" and "Created Time" attributes of records. For searching against other attributes, please create a view in Accompa first - then read the contents of that view using the Accompa API request for "Read View" -OR- search that view as described earlier in this page.

GET /re/search?last_updated_time>{time}

Returns list of requirements which were last updated after a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC).

GET /re/search?last_updated_time<{time}

Returns list of requirements which were last updated before a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC).

GET /re/search?created_time>{time}

Returns list of requirements which were created after a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC).

GET /re/search?created_time<{time}

Returns list of requirements which were created before a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC).

GET /re/search?deleted_time>{time}

Returns list of requirements which were deleted after a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC).

GET /re/search?deleted_time<{time}

Returns list of requirements which were deleted before a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC).

GET /re/search?last_updated_by={user_id}

Returns list of requirements which were last updated by a specific user.
{user_id} is the integer ID of the user.

GET /re/search?created_by={user_id}

Returns list of requirements which were created by a specific user.
{user_id} is the integer ID of the user.

GET /re/search?{field_name}={value}

Returns list of requirements which meet the criteria defined using {field_name}={value}.Searches are only supported against two field types:
1) {field_name} must be content of <name> element in the API response for GET /re/field - for which <type> element contains "Picklist". {value} must be an integer contained in a <value> element in the API response for GET /re/field- corresponding to the same field.
2) {field_name} must be content of <name> element in the API response for GET /re/field - for which <type> element contains "Textbox". {value} must be alphanumeric, no special characters are allowed at this time.

Multiple Criteria: You can combine multiple search criteria using "&" character.
Example: /search?created_time>{time}&created_by={user_id}

Availability: Available in Accompa API version "2" and later (Learn more about API versions).

RESPONSE

Status: 200 

<search_results>

  <requirement>

    <id>152</id>

    <id_prefix>RE-</id_prefix>

    <title>Test requirement for API</title>

    <version_number>7</version_number>

    <created_time unit="GMT Timestamp">1262493473</created_time>

    <last_updated_time unit="GMT Timestamp">1270683387</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </requirement>

  <requirement>

    <id>12</id>

    <id_prefix>RE-</id_prefix>

    <title>Export to CSV file</title>

    <version_number>6</version_number>

    <created_time unit="GMT Timestamp">1272493468</created_time>

    <last_updated_time unit="GMT Timestamp">1278683382</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </requirement>

  <requirement>

    <id>39</id>

    <id_prefix>RE-</id_prefix>

    <title>Save as PDF file</title>

    <version_number>14</version_number>

    <created_time unit="GMT Timestamp">1263493435</created_time>

    <last_updated_time unit="GMT Timestamp">1270583372</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </requirement>

  ...

</search_results>

Search All Records (for Features)

Searching all features is achieved via a HTTP GET request along with the search parameter.

At this time, Accompa REST API allows searches only against "Last Updated Time" and "Created Time" attributes of records. For searching against other attributes, please create a view in Accompa first - then read the contents of that view using the Accompa API request for "Read View" -OR- search that view as described earlier in this page.

GET /ft/search?last_updated_time>{time}

Returns list of features which were last updated after a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC).

GET /ft/search?last_updated_time<{time}

Returns list of features which were last updated before a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC).

GET /ft/search?created_time>{time}

Returns list of features which were created after a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC).

GET /ft/search?created_time<{time}

Returns list of features which were created before a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC).

GET /ft/search?deleted_time>{time}

Returns list of features which were deleted after a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC).

GET /ft/search?deleted_time<{time}

Returns list of features which were deleted before a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC).

GET /ft/search?last_updated_by={user_id}

Returns list of features which were last updated by a specific user.
{user_id} is the integer ID of the user.

GET /ft/search?created_by={user_id}

Returns list of features which were created by a specific user.
{user_id} is the integer ID of the user.

GET /ft/search?{field_name}={value}

Returns list of features which meet the criteria defined using {field_name}={value}.
Searches are only supported against two field types:
1) {field_name} must be content of <name> element in the API response for GET /ft/field - for which <type> element contains "Picklist". {value} must be an integer contained in a <value> element in the API response for GET /ft/field- corresponding to the same field.
2) {field_name} must be content of <name> element in the API response for GET /ft/field - for which <type> element contains "Textbox". {value} must be alphanumeric, no special characters are allowed at this time.

Multiple Criteria: You can combine multiple search criteria using "&" character.
Example: /search?created_time>{time}&created_by={user_id}

Availability: Available in Accompa API version "2" and later (Learn more about API versions).

RESPONSE

Status: 200 

<search_results>

  <feature>

    <id>152</id>

    <id_prefix>FT-</id_prefix>

    <title>Test feature for API</title>

    <version_number>7</version_number>

    <created_time unit="GMT Timestamp">1262493473</created_time>

    <last_updated_time unit="GMT Timestamp">1270683387</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </feature>

  <feature>

    <id>12</id>

    <id_prefix>FT-</id_prefix>

    <title>Export to CSV file</title>

    <version_number>6</version_number>

    <created_time unit="GMT Timestamp">1272493434</created_time>

    <last_updated_time unit="GMT Timestamp">1278683355</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </feature>

  <feature>

    <id>39</id>

    <id_prefix>FT-</id_prefix>

    <title>Save as PDF file</title>

    <version_number>14</version_number>

    <created_time unit="GMT Timestamp">1263493431</created_time>

    <last_updated_time unit="GMT Timestamp">1270583341</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </feature>

  ...

</search_results>

Search All Records (for Use Cases)

Searching all use cases is achieved via a HTTP GET request along with the search parameter.

At this time, Accompa REST API allows searches only against "Last Updated Time" and "Created Time" attributes of records. For searching against other attributes, please create a view in Accompa first - then read the contents of that view using the Accompa API request for "Read View" -OR- search that view as described earlier in this page.

GET /uc/search?last_updated_time>{time}

Returns list of use cases which were last updated after a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC).

GET /uc/search?last_updated_time<{time}

Returns list of use cases which were last updated before a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC).

GET /uc/search?created_time>{time}

Returns list of use cases which were created after a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC).

GET /uc/search?created_time<{time}

Returns list of use cases which were created before a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC).

GET /uc/search?deleted_time>{time}

Returns list of use cases which were deleted after a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC).

GET /uc/search?deleted_time<{time}

Returns list of use cases which were deleted before a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC).

GET /uc/search?last_updated_by={user_id}

Returns list of use cases which were last updated by a specific user.
{user_id} is the integer ID of the user.

GET /uc/search?created_by={user_id}

Returns list of use cases which were created by a specific user.
{user_id} is the integer ID of the user.

GET /uc/search?{field_name}={value}

Returns list of use cases which meet the criteria defined using {field_name}={value}.
Searches are only supported against two field types:
1) {field_name} must be content of <name> element in the API response for GET /uc/field - for which <type> element contains "Picklist". {value} must be an integer contained in a <value> element in the API response for GET /uc/field- corresponding to the same field.
2) {field_name} must be content of <name> element in the API response for GET /uc/field - for which <type> element contains "Textbox". {value} must be alphanumeric, no special characters are allowed at this time.

Multiple Criteria: You can combine multiple search criteria using "&" character.
Example: /search?created_time>{time}&created_by={user_id}

Availability: Available in Accompa API version "2" and later (Learn more about API versions).

RESPONSE

Status: 200 

<search_results>

  <use_case>

    <id>152</id>

    <id_prefix>UC-</id_prefix>

    <title>Test use case for API</title>

    <version_number>7</version_number>

    <created_time unit="GMT Timestamp">1262493473</created_time>

    <last_updated_time unit="GMT Timestamp">1270683387</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </use_case>

  <use_case>

    <id>12</id>

    <id_prefix>UC-</id_prefix>

    <title>Export to CSV file</title>

    <version_number>6</version_number>

    <created_time unit="GMT Timestamp">1272493447</created_time>

    <last_updated_time unit="GMT Timestamp">1278683392</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </use_case>

  <use_case>

    <id>39</id>

    <id_prefix>UC-</id_prefix>

    <title>Save as PDF file</title>

    <version_number>14</version_number>

    <created_time unit="GMT Timestamp">1263493441</created_time>

    <last_updated_time unit="GMT Timestamp">1270583332</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </use_case>

  ...

</search_results>

Search All Records (for a Custom Object)

Searching all records of a Custom Object is achieved via a HTTP GET request along with the search parameter.

At this time, Accompa REST API allows searches only against "Last Updated Time" and "Created Time" attributes of records. For searching against other attributes, please create a view in Accompa first - then read the contents of that view using the Accompa API request for "Read View" -OR- search that view as described earlier in this page.

GET /{api_prefix}/search?last_updated_time>{time}

Returns list of records of a Custom Object which were last updated after a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC). {api_prefix} is the value of the <api_prefix> element in the API response to GET /object API request.

GET /{api_prefix}/search?last_updated_time<{time}

Returns list of records of a Custom Object which were last updated before a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC). {api_prefix} is the value of the <api_prefix> element in the API response to GET /object API request.

GET /{api_prefix}/search?created_time>{time}

Returns list of records of a Custom Object which were created after a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC). {api_prefix} is the value of the <api_prefix> element in the API response to GET /object API request.

GET /{api_prefix}/search?created_time<{time}

Returns list of records of a Custom Object which were created before a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC). {api_prefix} is the value of the <api_prefix> element in the API response to GET /object API request.

GET /{api_prefix}/search?deleted_time>{time}

Returns list of records of a Custom Object which were deleted after a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC). {api_prefix} is the value of the <api_prefix> element in the API response to GET /object API request.

GET /{api_prefix}/search?deleted_time<{time}

Returns list of records of a Custom Object which were deleted before a specific time.
{time} is a 10-digit integer UNIX timestamp (UTC). {api_prefix} is the value of the <api_prefix> element in the API response to GET /object API request.

GET /{api_prefix}/search?last_updated_by={user_id}

Returns list of records of a Custom Object which were last updated by a specific user.
{user_id} is the integer ID of the user. {api_prefix} is the value of the <api_prefix> element in the API response to GET /object API request.

GET /{api_prefix}/search?created_by={user_id}

Returns list of records of a Custom Object which were created by a specific user.
{user_id} is the integer ID of the user. {api_prefix} is the value of the <api_prefix> element in the API response to GET /object API request.

GET /{api_prefix}/search?{field_name}={value}

Returns list of records of a Custom Object which meet the criteria defined using {field_name}={value}.
{api_prefix} is the value of the <api_prefix> element in the API response to GET /object API request.
Searches are only supported against two field types:
1) {field_name} must be content of <name> element in the API response for GET /{api_prefix}/field - for which <type> element contains "Picklist". {value} must be an integer contained in a <value> element in the API response for GET /{api_prefix}/field- corresponding to the same field.
2) {field_name} must be content of <name> element in the API response for GET /{api_prefix}/field - for which <type> element contains "Textbox". {value} must be alphanumeric, no special characters are allowed at this time.

Multiple Criteria: You can combine multiple search criteria using "&" character.
Example: /search?created_time>{time}&created_by={user_id}

Availability: Available in Accompa API version "2" and later (Learn more about API versions).

RESPONSE

Status: 200 

<search_results>

  <custom_object>

    <id>152</id>

    <id_prefix>CO-</id_prefix>

    <title>Test task for API</title>

    <version_number>7</version_number>

    <created_time unit="GMT Timestamp">1262493473</created_time>

    <last_updated_time unit="GMT Timestamp">1270683387</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </custom_object>

  <custom_object>

    <id>12</id>

    <id_prefix>CO-</id_prefix>

    <title>Export to CSV file</title>

    <version_number>6</version_number>

    <created_time unit="GMT Timestamp">1272493447</created_time>

    <last_updated_time unit="GMT Timestamp">1278683392</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </custom_object>

  <custom_object>

    <id>39</id>

    <id_prefix>CO-</id_prefix>

    <title>Save as PDF file</title>

    <version_number>14</version_number>

    <created_time unit="GMT Timestamp">1263493441</created_time>

    <last_updated_time unit="GMT Timestamp">1270583332</last_updated_time>

    <created_by>17</created_by>

    <last_updated_by>22</last_updated_by>

  </custom_object>

  ...

</search_results>

Home - Requirements Management Software - Terms of Service - Privacy Policy