GET Activities

Returns a list of activity summary records.

Request Information

URI Parameters

Name Description Type Additional information
Page Specifies the page number of the result set to return. integer

None.

PageSize Specifies the number of records on each page of results. Maximum page size is 100. Defaults to 25 if not specified. integer

None.

WsAccessKey The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access. string

Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred.

FileId Specifies the file id of the file to perform the operation upon. integer

Required

LastModifiedFromDate Filter records with LastModifiedDate greater than or equal to a date in UTC (must also specifiy LastModifiedToDate). date

None.

LastModifiedToDate Filter records with LastModifiedDate less than or equal to a date in UTC (must also specifiy LastModifiedFromDate). date

None.

Tags One or more tags that are used to filter the result set by. More tags can be separated with a comma, for example 'tags=tag1,tag2'. string

None.

TagSelection Specifies how to filter when using the supplied tags.Valid values are: requireAny - filter records with ANY ONE of the supplied tags, requireAll - filter records with ALL of the supplied tags, excludeAny - filter records excluding any records with ANY ONE of the specified tags, excludeAll - filter records excluding any records with ALL of the specified tags. string

None.

FromDate Filter records with Date greater than or equal to a date (must also specifiy ToDate). string

None.

ToDate Filter records with Date less than or equal to a date (must also specifiy FromDate). string

None.

SearchText Filter item records by specifying text to search for in code or description. string

None.

ActivityStatus Filter records by the status of the activity. Valid values are 'todo', 'done', 'overdue'. string

None.

ActivityType Filter records by the type of the activity. Valid values are all tags with activity flag set to true. string

None.

OwnerEmail Filter records by the owner of the activity. Value should be user's login email. string

None.

Body Parameters

None.

Response Information

Resource Description

ActivitySummaryReponse
Name Description Type Additional information
Activities List of activities. Collection of ActivitySummary

None.

_links Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server. Collection of Link

None.

Response Formats

application/json, text/json

Sample:
{
  "Activities": [
    {
      "Id": 111,
      "LastUpdatedId": "AAAAKlh=",
      "ActivityType": "TestType",
      "Done": false,
      "Due": "2017-10-29T07:32:15.6280569+11:00",
      "Title": "Test Actvity 1",
      "OwnerFirstName": "John",
      "OwnerLastName": "Smith",
      "OwnerEmail": "someone@test.com",
      "AttachedToType": "sale",
      "AttachedToId": 321,
      "Tags": [
        "testTag1",
        "testTag2"
      ],
      "CreatedDateUtc": "2017-07-11T07:32:15.6280569+10:00",
      "LastModifiedDateUtc": "2017-10-18T07:32:15.6280569+11:00",
      "_links": [
        {
          "rel": "detail",
          "href": "https://api.saasu.com/Activity/111?FileId=123",
          "method": "GET",
          "title": null
        }
      ]
    },
    {
      "Id": 222,
      "LastUpdatedId": "AAAAKli=",
      "ActivityType": "TestType",
      "Done": false,
      "Due": "2017-10-29T07:32:15.6280569+11:00",
      "Title": "Test Actvity 2",
      "OwnerFirstName": "John",
      "OwnerLastName": "Smith",
      "OwnerEmail": "someone@test.com",
      "AttachedToType": "purchase",
      "AttachedToId": 322,
      "Tags": [
        "testTag1",
        "testTag2"
      ],
      "CreatedDateUtc": "2017-07-11T07:32:15.6280569+10:00",
      "LastModifiedDateUtc": "2017-10-18T07:32:15.6280569+11:00",
      "_links": [
        {
          "rel": "detail",
          "href": "https://api.saasu.com/Activity/222?FileId=123",
          "method": "GET",
          "title": null
        }
      ]
    }
  ],
  "_links": [
    {
      "rel": "self",
      "href": "https://api.saasu.com/Activities?FileId=123",
      "method": "GET",
      "title": null
    },
    {
      "rel": "next",
      "href": "https://api.saasu.com/Activities?FileId=123&Page=2&PageSize=25",
      "method": "GET",
      "title": null
    }
  ]
}

application/xml, text/xml

Sample:
<ActivitySummaryReponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <_links>
    <Link>
      <rel>self</rel>
      <href>https://api.saasu.com/Activities?FileId=123</href>
      <method>GET</method>
    </Link>
    <Link>
      <rel>next</rel>
      <href>https://api.saasu.com/Activities?FileId=123&amp;Page=2&amp;PageSize=25</href>
      <method>GET</method>
    </Link>
  </_links>
  <Activities>
    <ActivitySummary>
      <_links>
        <Link>
          <rel>detail</rel>
          <href>https://api.saasu.com/Activity/111?FileId=123</href>
          <method>GET</method>
        </Link>
      </_links>
      <Id>111</Id>
      <LastUpdatedId>AAAAKlh=</LastUpdatedId>
      <ActivityType>TestType</ActivityType>
      <Done>false</Done>
      <Due>2017-10-29T07:32:15.6280569+11:00</Due>
      <Title>Test Actvity 1</Title>
      <OwnerFirstName>John</OwnerFirstName>
      <OwnerLastName>Smith</OwnerLastName>
      <OwnerEmail>someone@test.com</OwnerEmail>
      <AttachedToType>sale</AttachedToType>
      <AttachedToId>321</AttachedToId>
      <Tags>
        <string>testTag1</string>
        <string>testTag2</string>
      </Tags>
      <CreatedDateUtc>2017-07-11T07:32:15.6280569+10:00</CreatedDateUtc>
      <LastModifiedDateUtc>2017-10-18T07:32:15.6280569+11:00</LastModifiedDateUtc>
    </ActivitySummary>
    <ActivitySummary>
      <_links>
        <Link>
          <rel>detail</rel>
          <href>https://api.saasu.com/Activity/222?FileId=123</href>
          <method>GET</method>
        </Link>
      </_links>
      <Id>222</Id>
      <LastUpdatedId>AAAAKli=</LastUpdatedId>
      <ActivityType>TestType</ActivityType>
      <Done>false</Done>
      <Due>2017-10-29T07:32:15.6280569+11:00</Due>
      <Title>Test Actvity 2</Title>
      <OwnerFirstName>John</OwnerFirstName>
      <OwnerLastName>Smith</OwnerLastName>
      <OwnerEmail>someone@test.com</OwnerEmail>
      <AttachedToType>purchase</AttachedToType>
      <AttachedToId>322</AttachedToId>
      <Tags>
        <string>testTag1</string>
        <string>testTag2</string>
      </Tags>
      <CreatedDateUtc>2017-07-11T07:32:15.6280569+10:00</CreatedDateUtc>
      <LastModifiedDateUtc>2017-10-18T07:32:15.6280569+11:00</LastModifiedDateUtc>
    </ActivitySummary>
  </Activities>
</ActivitySummaryReponse>