Count Changes to a Custom Object Instance

Returns the total number of changes made to an instance of a custom object.

 

URL

{RMUrl}/api/objects/<ObjectVariableName>/<InstanceID>/snapshots/count[?[[&]$filter=<filter>][[&]page=<Page>][[&]page_size=<PageSize>][[&]$orderby=<field1[desc],field2[desc]…fieldN[desc]>]]

 

REQUEST METHOD

GET

 

URL PARAMETERS

ObjectVariableName: This parameter is provided in the URL and does not need to be sent through GET.

InstanceID: This parameter is provided in the URL and does not need to be sent through GET.

page: Number of the page to be displayed. Valid values: 1 to the maximum number of pages. If omitted, the value 1 is used. If the value is greater than the maximum number of pages, a blank list will be returned.

page_size: Number of items displayed per page. Valid values: 1 to 1,000. If omitted, the default value of 10 is used.

filter: Query based on the OData protocol syntax for configuring filters. The fields supported are listed below. See the examples to view the operations allowed.

orderby: Orders the groups listed on the page by field. To order by more than one field, use a comma between the field names. For descending order, add the word "desc" for each desired field. The supported fields are listed below.

 

FIELDS SUPPORTED BY FILTER

datetime SnapshotDate;

string Differences/Name;

string Author/Id;

string Author/Name;

string Author/UserName;

 

 

For detailed information on filters as supported operators, which filters apply to which data types, and more examples, see Appendix 3: Filters.

 

REQUEST EXAMPLE

See examples in the "List Modifications to Instances of Custom Objects" section.

 

SUCCESS RESPONSE

Value corresponding to the total number of instances of an object. Returns an int.