GET Task

GET Task

This request method returns the task 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?format=xml/json

You may use either JSON or XML formats in your GET submission.
You indicate this by setting the ContentType HTTP header as “application/json” or “application/xml”.

If no ContentType is specified, XML format is assumed.

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”

Endpoints & API Explorer

NodeAPI EndpointAPI Explorer
US/api/v2/task Model Description/Schema & Parameters

Parameters

The GET verb allows you to return details of the specified task matching the given criteria.
The required and optional parameters for a GET 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.    ✓
IdStringThe Task’s unique identifier✓
RetrieveEntriesBooleanWhether to include form entries on ‘Fill Out Form’ activities. 
MediaAsUrlBoolean

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

 
AnswerFormatString

Specify which structure to use for answers when retrieve entries is true (Raw does not apply).

 

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?Id=dd3XXXXXXXXXXXXXXXXXXXXXXXXXX&CompanyId=6XXXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Response Body

{
  "Task": {
    "Id": "dd3XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "UserId": "c9bXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "UserEmail": "XXXXXXXXX@XXXXXXXXX.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": "84cXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "EntryId": "b19XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "ActivityType": "FillOutForm",
        "ActivityId": "221XXXXXXXXXXXXXXXXXXXXXXXXXXXX"
      },
      {
        "FormId": "088XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "EntryId": "ec9XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "ActivityType": "FillOutForm",
        "ActivityId": "87fXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
      },
      {
        "Instruction": "Please make sure you bring the keys back.",
        "ActivityType": "Instruction",
        "ActivityId": "f62XXXXXXXXXXXXXXXXXXXXXXXXXXXX"
      }
    ],
    "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 Task

      The Tasks API allows you to retrieve, create and delete Tasks on the platform. This enables scenarios where jobs created/maintained in other systems (e.g. SAP, Salesforce) can be delivered through to your app users automatically. Any new Task created ...

    • Get Tasks (Task Search)

      Using the TaskkSearch API The TaskkSearch API allows you to search for multiple Tasks at a time To search for and retrieve multiple Tasks at once, use a GET with the search API found at: ...

    • GET Task (Search)

      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. ...

    • GET Task Recurring

      This request method allows you to find the recurring task 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 ...

    • GET Task Recurring (Search)

      This request method lets you find all recurring tasks matching the provided search 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 ...