Objects |
| This page explains how to use the Accompa REST API to retrieve information about "Objects" in your company's Accompa account. (What is an Object?) |
| |
Read the List of Objects in Your Account
|
| Reading the list of objects is achieved via a HTTP GET request to the following URI. |
| |
| GET /object |
| Returns the list of objects in your company's Accompa account. |
| |
| Availability: Available in Accompa API version "2" and later (Learn more about API versions). |
| |
| RESPONSE |
Status: 200
<objects>
<object>
<object_unique_id>4i8T-BgZUz2NGEuwcZP0jHrNJsuv6xVbF0HF8g8_jTc</object_unique_id>
<api_prefix>re</api_prefix>
<name_singular>Requirement</name_singular>
<name_plural>Requirements</name_plural>
<description />
<id_prefix>RQ</id_prefix>
<custom_object>No</custom_object>
<deploy_status>Deployed</deploy_status>
</object>
<object>
<object_unique_id>07bHzBgZUz2NGEuwcZP0jHrNJsuv6xVbF0HF8g809gH</object_unique_id>
<api_prefix>ft</api_prefix>
<name_singular>Feature</name_singular>
<name_plural>Features</name_plural>
<description />
<id_prefix>FT</id_prefix>
<custom_object>No</custom_object>
<deploy_status>Deployed</deploy_status>
</object>
<object>
<api_prefix>uc</api_prefix>
<object_unique_id>8jKiBegZUz2NGEuwcZP0jHrNJsuv6xVbF0HF8g8k6Bb</object_unique_id>
<name_singular>Use Case</name_singular>
<name_plural>Use Cases</name_plural>
<description />
<id_prefix>UC</id_prefix>
<custom_object>No</custom_object>
<deploy_status>Deployed</deploy_status>
</object>
<object>
<object_unique_id>kJ0BvCtYUz2NGEuwcZP0jHrNJsuv6xVbF0HF8g8yZxY</object_unique_id>
<api_prefix>tcs</api_prefix>
<name_singular>Test Case</name_singular>
<name_plural>Test Cases</name_plural>
<description />
<id_prefix>TCS</id_prefix>
<custom_object>Yes</custom_object>
<deploy_status>Deployed</deploy_status>
</object>
...
</objects>
|
If the request is valid, an XML response will be generated along with the status code "200". The XML response will contain the list of objects in your company's Accompa account, as shown above.
If the request is invalid, the response will have a status other than "200", usually along with an error message in XML format. |
| |
