GET Task (Search)

GET Task (Search)

TABLE OF CONTENTS

Additional Info

This request method allows you to find all tasks matching the given criteria.  On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb. The format query string parameter controls the desired response format. Specify either XML or JSON.


/api/v2/task/search?format=xml/json


All XML formatted requests must specify the following XML namespace in the data source root element:
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"

Parameters

The GET verb allows you to find all tasks matching the given criteria. The required and optional parameters for a GET(Search) call to the Task API are outlined below.

NameTypeDescriptionRequired
CompanyIdIntegerYour unique Company Id is found on the Organisation Setup page of the secure website.✓
IntegrationKeyStringYour unique Integration Key is found on the Organisation Setup page of the secure website.    ✓
UserEmailStringUser email to find Tasks for.
UserExternalIdStringUser external ID to find Tasks for.
StatusStringFind Tasks in the given status. Defaults to retrieve all if not specified.
TemplateIdString

Find Tasks created from the given Task Template identifier.


FromDateDateFind Tasks updated on or since the given UTC date/time in ISO-8601 format.
ToDateDateFind Tasks updated up to and including the given UTC date/time in ISO-8601 format.
NameStringFind Tasks with names that contain the provided text.
RetrieveEntriesBooleanInclude form entries on 'Fill Out Form' activities if any exist
MediaAsUrlBoolean

Media field answers are returned as full file download URLs when including form entries instead of just the file name. True by default.


AnswerFormatString

Specify which format to use for answers when retrieving entries is true.


EntryFieldsString

Optionally restrict returned Form entry answer values to the given comma-separated list of field data names.

ONLY SUPPORTED WITH 'FLAT' ANSWER FORMAT.


PageNoIntegerThe page number from which to start reading results (0 based).
PageSizeIntegerThe page size (number of rows) to return. The maximum allowable value is 250.

Example

Given that the API is REST-based, you can access the API directly via your web browser to test or by using Postman API Platform.


Request URL

https://eforms.mobileform.net:443/api/v2/task/search?DateOrder=Ascending&CompanyId=6XXXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXXX
JavaScript

Request Body

{
  "Tasks": [
    {
      "Id": "dd3XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "UserId": "c9bXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "UserEmail": "cXXXXXXXXXXXX@XXXXXXXXXXXX.com",
      "UserExternalId": "test_user_extid",
      "Name": "Test task",
      "Icon": "Flag",
      "Status": "InProgress",
      "CompleteBy": "2021-04-02T22:27:00.0000000Z",
      "StartBy": "2021-04-02T21:27:00.0000000Z",
      "IsAllDay": false,
      "CompleteAtText": "",
      "AdditionalInfo": "This is a test.",
      "DisableNotes": false,
      "UserCanReject": false,
      "RestrictToGroup": "00000000000000000000000000000000",
      "UserCanReassign": false,
      "ReassignType": "Any",
      "Activities": [
        {
          "FormId": "84cXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
          "EntryId": "b19XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
          "ActivityType": "FillOutForm",
          "ActivityId": "221XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
        },
        {
          "FormId": "088XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
          "EntryId": "ec9XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
          "ActivityType": "FillOutForm",
          "ActivityId": "87fbXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
        },
        {
          "Instruction": "Please make sure you bring the keys back.",
          "ActivityType": "Instruction",
          "ActivityId": "f62XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
        }
      ],
      "Files": [],
      "History": [
        {
          "EventDate": "2021-04-01T14:28:00.7670000Z",
          "Status": "Draft"
        },
        {
          "EventDate": "2021-04-01T14:28:31.4800000Z",
          "Status": "Sent"
        },
        {
          "EventDate": "2021-04-01T14:28:49.1230000Z",
          "Status": "InProgress"
        }
      ],
      "StartTime": "2021-04-01T14:28:48.5400000Z",
      "CompleteTime": "1990-01-01T00:00:01.0000000Z",
      "CompanyId": 6XXXX
    }

    • Related Articles

    • GET Usergroup (Search)

      TABLE OF CONTENTS Parameters Example This API allows you to find all user groups matching the given parameters. This API is available via SSL-secured HTTPS connection on the Cloud using the REST GET verb. The format query string parameter controls ...

    • GET Folder (Search)

      The GET Folder (Search) API finds all folders matching the given parameters. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb. The format query string parameter controls the desired response format. Specify ...

    • GET Screen (Map Search)

      The GET Screen (Map Search) API returns the Published version of matching Map Screens or all versions of a single specified Map Screen. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb. The format query ...

    • GET Screen (Search)

      TABLE OF CONTENTS Parameters Example The Screen API returns the Published version of matching Forms or all versions of a specified Form. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb. The format query ...

    • GET Screen (Iconboard Search)

      TABLE OF CONTENTS Parameters Example The GET Screen (Iconboard Search) API returns the Published version of the matching Icon Boards or all versions of a specified Icon Board. On the Cloud, this API is available via SSL-secured HTTPS connection using ...