Views |
| This page explains how to use the Accompa REST API to retrieve information about "Views" in your Accompa account. (What is a View?) |
| |
Read Contents of a Specific View (Containing Requirements)
|
| Reading contents of a specific requirements view is achieved via a HTTP GET request to its URI. |
| |
| GET /re/view/{id} |
| Returns list of requirements contained in the view whose integer ID is {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>12</created_by>
<last_updated_by>32</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>32</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 for that particular view, 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. |
| |
Read Contents of a Specific View (Containing Features)
|
| Reading contents of a specific features view is achieved via a HTTP GET request to its URI. |
| |
| GET /ft/view/{id} |
| Returns list of features contained in the view whose integer ID is {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 for that particular view, 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. |
| |
Read Contents of a Specific View (Containing Use Cases)
|
| Reading contents of a specific use cases view is achieved via a HTTP GET request to its URI. |
| |
| GET /uc/view/{id} |
| Returns list of use cases contained in the view whose integer ID is {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 for that particular view, 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. |
| |
Read Contents of a Specific View (Containing a Custom Object)
|
| Reading contents of a specific view for a Custom Object is achieved via a HTTP GET request to its URI. |
| |
| GET /{api_prefix}/view/{id} |
| Returns list of records contained in the view of a Custom Object. {api_prefix} is the value of the <api_prefix> element in the API response to GET /object API request. {id} is the integer ID of the view. |
| |
| 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 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>
</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> |
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 for that particular view, 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. |
| |
Read List of Views (for Requirements)
|
| Reading the list of all requirements views on your Accompa account is achieved via a HTTP GET request to its URI. |
| |
| GET /re/view |
| Returns the list of all requirements views on your Accompa account |
| |
| Availability: Available in Accompa API version "2" and later (Learn more about API versions). |
| |
| RESPONSE |
Status: 200
<views>
<view>
<view_id>2697</view_id>
<name>Version-5 Reqs</name>
<description>This view displays requirements for Version-5 of our HRM suite.</description>
<created_by_firstname>Natalie</created_by_firstname>
<created_by_lastname>McLean</created_by_lastname>
</view>
<view>
<view_id>2699</view_id>
<name>SuperCRM v5.1 Release</name>
<description>These are requirements for v5.1 release of our SuperCRM product.</description>
<created_by_firstname>Robert</created_by_firstname>
<created_by_lastname>Thomason</created_by_lastname>
</view>
<view>
<view_id>2793</view_id>
<name>Return Score Greater Than 50</name>
<description>These are all the requirements with "Return Score" greater than 50.</description>
<created_by_firstname>Matt</created_by_firstname>
<created_by_lastname>Schmidt</created_by_lastname>
</view>
...
</views> |
| |
Read List of Views (for Features)
|
| Reading the list of all features views on your Accompa account is achieved via a HTTP GET request to its URI. |
| |
| GET /ft/view |
| Returns the list of all features views on your Accompa account |
| |
| Availability: Available in Accompa API version "2" and later (Learn more about API versions). |
| |
| RESPONSE |
Status: 200
<views>
<view>
<view_id>2697</view_id>
<name>Version-5 Features</name>
<description>This view displays features for Version-5 of our HRM suite.</description>
<created_by_firstname>Natalie</created_by_firstname>
<created_by_lastname>McLean</created_by_lastname>
</view>
<view>
<view_id>2699</view_id>
<name>SuperCRM v5.1 Release</name>
<description>These are features for v5.1 release of our SuperCRM product.</description>
<created_by_firstname>Robert</created_by_firstname>
<created_by_lastname>Thomason</created_by_lastname>
</view>
<view>
<view_id>2793</view_id>
<name>Return Score Greater Than 50</name>
<description>These are all the features with "Return Score" greater than 50.</description>
<created_by_firstname>Matt</created_by_firstname>
<created_by_lastname>Schmidt</created_by_lastname>
</view>
...
</views> |
| |
Read List of Views (for Use Cases)
|
| Reading the list of all use cases views on your Accompa account is achieved via a HTTP GET request to its URI. |
| |
| GET /uc/view |
| Returns the list of all use cases views on your Accompa account |
| |
| Availability: Available in Accompa API version "2" and later (Learn more about API versions). |
| |
| RESPONSE |
Status: 200
<views>
<view>
<view_id>2697</view_id>
<name>Version-5 Use Cases</name>
<description>This view displays use cases for Version-5 of our HRM suite.</description>
<created_by_firstname>Natalie</created_by_firstname>
<created_by_lastname>McLean</created_by_lastname>
</view>
<view>
<view_id>2699</view_id>
<name>SuperCRM v5.1 Release</name>
<description>These are use cases for v5.1 release of our SuperCRM product.</description>
<created_by_firstname>Robert</created_by_firstname>
<created_by_lastname>Thomason</created_by_lastname>
</view>
<view>
<view_id>2793</view_id>
<name>Return Score Greater Than 50</name>
<description>These are all the use cases with "Return Score" greater than 50.</description>
<created_by_firstname>Matt</created_by_firstname>
<created_by_lastname>Schmidt</created_by_lastname>
</view>
...
</views> |
| |
Read List of Views (for a Custom Object)
|
| Reading the list of all views on your Accompa account for a Custom Object is achieved via a HTTP GET request to its URI. |
| |
| GET /{api_prefix}/view |
| Returns the list of all views for a for a Custom Object on your Accompa account. {api_prefix} is the value of the <api_prefix> element in the API response to GET /object API request. |
| |
| Availability: Available in Accompa API version "2" and later (Learn more about API versions). |
| |
| RESPONSE |
Status: 200
<views>
<view>
<view_id>2697</view_id>
<name>Version-5 Tasks</name>
<description>This view displays tasks for Version-5 of our HRM suite.</description>
<created_by_firstname>Natalie</created_by_firstname>
<created_by_lastname>McLean</created_by_lastname>
</view>
<view>
<view_id>2699</view_id>
<name>SuperCRM v5.1 Tasks</name>
<description>These are tasks for v5.1 release of our SuperCRM product.</description>
<created_by_firstname>Robert</created_by_firstname>
<created_by_lastname>Thomason</created_by_lastname>
</view>
<view>
<view_id>2793</view_id>
<name>Return Score Greater Than 50</name>
<description>These are all the tasks with "Return Score" greater than 50.</description>
<created_by_firstname>Matt</created_by_firstname>
<created_by_lastname>Schmidt</created_by_lastname>
</view>
...
</views> |
| |
