Field History |
| This page explains how to use the Accompa REST API to retrieve information about "History" of a specific field related to a record in your Accompa account. |
| |
Read History of a Specific Field related to a Requirement
|
| Reading field history of a specific field related to a requirement is achieved via a HTTP GET request shown below. |
| |
| GET /re/{id}/fieldhistory/{field_id} |
Returns history for a specific field related to a requirement.
{field_id} is the value of the <id> element in the API response to GET /re/field API request. {id} is the integer ID of the requirement.
|
| |
Read History of a Specific Field related to a Feature
|
| Reading field history of a specific field related to a feature is achieved via a HTTP GET request shown below. |
| |
| GET /ft/{id}/fieldhistory/{field_id} |
Returns history for a specific field related to a feature.
{field_id} is the value of the <id> element in the API response to GET /ft/field API request. {id} is the integer ID of the feature.
|
| |
Read History of a Specific Field related to a Use Case
|
| Reading field history of a specific field related to a use case is achieved via a HTTP GET request shown below. |
| |
| GET /uc/{id}/fieldhistory/{field_id} |
Returns history for a specific field related to a use case.
{field_id} is the value of the <id> element in the API response to GET /uc/field API request. {id} is the integer ID of the use case.
|
| |
Read History of a Specific Field related to a Custom Object
|
| Reading field history of a specific field related to a Custom Object is achieved via a HTTP GET request shown below. |
| |
| GET /{api_prefix}/{id}/fieldhistory/{field_id} |
Returns history for a specific field related to a custom object.
{field_id} is the value of the <id> element in the API response to GET /{api_prefix}/field API request. {id} is the integer ID of the custom object.
|
| |
| Availability: Available in Accompa API version "2" and later (Learn more about API versions). |
| |
| RESPONSE - Text, Email, URL and Number fields |
Status: 200
<history_items>
<history>
<user_id>10</user_id>
<action>Modified</action>
<old_value>Save document as CSV file</old_value>
<new_value>Save document as PDF file</new_value>
<activity_time unit="GMT Timestamp">1262493473</activity_time>
</history>
...
</history_items> |
| |
| RESPONSE - "Text Area" fields |
Status: 200
<history_items>
<history>
<user_id>10</user_id>
<action>Modified</action>
<old_value><![CDATA[<b>Important:</b> We have received requests from many customers to allow them to save the file as a <i>CSV file</i> ]]></old_value>
<new_value><![CDATA[<b>Important:</b> We have received requests from many customers to allow them to save the file as a <i>CSV file</i> (see example of such a file at <a href="http://www.MyExampleDomain.com/example_file.csv">this link</a>) so that they can import into other software.]]></new_value>
<activity_time unit="GMT Timestamp">1262493473</activity_time>
</history>
...
</history_items> |
| |
| RESPONSE - "Picklist - Pick One" fields |
Status: 200
<history_items>
<history>
<user_id>10</user_id>
<action>Modified</action>
<old_value id="1">Accepted - Scheduled</old_value>
<new_value id="2">Accepted - Unscheduled</new_value>
<activity_time unit="GMT Timestamp">1262493473</activity_time>
</history>
...
</history_items> |
| |
| RESPONSE - "Picklist - Pick One" user fields |
Status: 200
<history_items>
<history>
<user_id>10</user_id>
<action>Modified</action>
<old_value id="173" email="mickey.mouse@disney.com">Mickey Mouse</old_value>
<new_value id="174" email="jason.bourne@treadstone.com">Jason Bourne</new_value>
<activity_time unit="GMT Timestamp">1262493473</activity_time>
</history>
...
</history_items> |
| |
| RESPONSE - "Picklist - Pick Multiple" fields |
Status: 200
<history_items>
<history>
<user_id>10</user_id>
<action>Modified</action>
<old_value>
<value id="1">Product-A</value>
<value id="2">Product-B</value>
</old_value>
<new_value>
<value id="3">Product-C</value>
<value id="4">Product-D</value>
</new_value>
<activity_time unit="GMT Timestamp">1262493473</activity_time>
</history>
...
</history_items> |
| |
| RESPONSE - "Picklist - Pick Multiple" user fields |
Status: 200
<history_items>
<history>
<user_id>10</user_id>
<action>Modified</action>
<old_value>
<value id="173" email="mickey.mouse@disney.com">Mickey Mouse</value>
</old_value>
<new_value>
<value id="173" email="mickey.mouse@disney.com">Mickey Mouse</value>
<value id="174" email="jason.bourne@treadstone.com">Jason Bourne</value>
</new_value>
<activity_time unit="GMT Timestamp">1262493473</activity_time>
</history>
...
</history_items> |
| |
| RESPONSE - Date fields |
Status: 200
<history_items>
<history>
<user_id>10</user_id>
<action>Modified</action>
<old_value>
<year>2019</year>
<month>01</month>
<date>20</date>
<timezone>GMT</timezone>
</old_value>
<new_value>
<year>2019</year>
<month>02</month>
<date>15</date>
<timezone>GMT</timezone>
</new_value>
<activity_time unit="GMT Timestamp">1262493473</activity_time>
</history>
...
</history_items> |
| |
| RESPONSE - "Checkbox" fields |
Status: 200
<history_items>
<history>
<user_id>10</user_id>
<action>Modified</action>
<old_value value="0">Unchecked</old_value>
<new_value value="1">Checked</new_value>
<activity_time unit="GMT Timestamp">1262493473</activity_time>
</history>
...
</history_items> |
If the field with ID matching {field_id}, related to record with ID matching {id} has one or more history records, an XML response will be generated along with the status code "200". The XML response will contain the list of history items, as shown above.
If the field with ID matching {field_id}, related to record with ID matching {id} has no history records, the XML response will still be generated along with the status code "200" - but the <history_items> element will not contain any children.
|
| |
| |
