Reference

Taskitem

The taskitem object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this taskitem
Active: bool optional
DelayInHours: int required
DisplayToEveryone: bool optional
Name: string required
NotifyByEmail: bool optional
ResponsibleId: Id required
TaskListId: Id required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this taskitem
SystemId: string optional api-only
User defined data about this taskitem. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "Active": false,
  "DelayInHours": ,
  "DisplayToEveryone": false,
  "Name": "Name",
  "NotifyByEmail": false,
  "ResponsibleId": 12345678,
  "TaskListId": 12345678,
  "UniqueId": "536174ac-5bac-4e6f-9f5c-e6866c933713",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a TaskItem

This endpoint allows you to GET a list of taskitems based on one or more filter querystring parameters.

GET https://spaces.nexudus.com/api/crm/taskitems?...

πŸ”’ Requires role "TaskItem-List"

Pagination querystring parameters
Lets control how many records to return at a time and their order.
page integer optional
?page=1
size integer optional default=25
Sets the maximum number of records to return each page of results.
?size=25
orderby string optional default=DelayInHours
Sets the property to use when ordering the results of the search.
?orderby=Id
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records.
?sort=ascending

Search querystring parameters
Lets you search taskitem records based on their different properties.
Id number
?Id=12345678
TaskItem_Active bool
?TaskItem_Active=...
TaskItem_DelayInHours int
?TaskItem_DelayInHours=...
TaskItem_DisplayToEveryone bool
?TaskItem_DisplayToEveryone=...
TaskItem_Name string
?TaskItem_Name=...
TaskItem_NotifyByEmail bool
?TaskItem_NotifyByEmail=...
TaskItem_Responsible User
?TaskItem_Responsible=...
TaskItem_TaskList TaskList
?TaskItem_TaskList=...
TaskItem_ResponsibleFullName string
?TaskItem_ResponsibleFullName=...

Range search querystring parameters
Lets you search taskitem records based on a range of date or numeric values.
To_TaskItem_CreatedOn date
?To_TaskItem_CreatedOn=2010-01-01T20:32
From_TaskItem_CreatedOn date
?From_TaskItem_CreatedOn=2010-01-01T20:32
To_TaskItem_UpdatedOn date
?To_TaskItem_UpdatedOn=2010-01-01T20:32
From_TaskItem_UpdatedOn date
?From_TaskItem_UpdatedOn=2010-01-01T20:32
To_TaskItem_DelayInHours number
?To_TaskItem_DelayInHours=0
From_TaskItem_DelayInHours number
?From_TaskItem_DelayInHours=10

Example request

GET https://spaces.nexudus.com/api/crm/taskitems?TaskItem_Name=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "TaskList": ,
        "Responsible": ,
        "Name": "Name",
        "Active": false,
        "NotifyByEmail": false,
        "DisplayToEveryone": false,
        "DelayInHours": ,
        "TaskItemResponsibleFullName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "e752218e-0b3d-4772-88dc-3cc29b2c8840",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 25,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 60,
    "TotalPages": 3
}


Find TaskItems by IDs

Gets one or more taskitem records based on their Id.
GET https://spaces.nexudus.com/api/crm/taskitems?TaskItem_Id=[:id1,:id2,...]

πŸ”’ Requires role "TaskItem-List"

Querystring parameters
TaskItem_Id: array requried
?TaskItem_Id=[12345678,87654651]

Example request

GET https://spaces.nexudus.com/api/crm/taskitems?TaskItem_Id=[1234567,9876541]
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "TaskList": ,
        "Responsible": ,
        "Name": "Name",
        "Active": false,
        "NotifyByEmail": false,
        "DisplayToEveryone": false,
        "DelayInHours": ,
        "TaskItemResponsibleFullName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "105b94aa-fa20-4349-b284-b4a6f2bd35a6",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "DelayInHours",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}


Get single TaskItem by Id

Gets one taskitem record by its Id.
GET https://spaces.nexudus.com/api/crm/taskitems/:Id

πŸ”’ Requires role "TaskItem-Read"

URL parameters
Id: number requried

Example request

GET https://spaces.nexudus.com/api/crm/taskitems/1234567
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
  "Id": 1234567,
  "Active": false,
  "DelayInHours": ,
  "DisplayToEveryone": false,
  "Name": "Name",
  "NotifyByEmail": false,
  "ResponsibleId": 12345678,
  "TaskListId": 12345678,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "3eeedb8e-8243-4364-8012-2c81026bb3e1",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new TaskItem

Creates a new taskitem.
POST https://spaces.nexudus.com/api/crm/taskitems

πŸ”’ Requires role "TaskItem-Create"

Body parameters
TaskListId: number required
ResponsibleId: number required
Name: string required
Active: bool optional
NotifyByEmail: bool optional
DisplayToEveryone: bool optional
DelayInHours: int required

Example request

POST https://spaces.nexudus.com/api/crm/taskitems
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "TaskListId": 12345678,
    "ResponsibleId": 12345678,
    "Name": "Name",
    "Active": false,
    "NotifyByEmail": false,
    "DisplayToEveryone": false,
    "DelayInHours": ,
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully created.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Update TaskItem

Updates an existing taskitem.
PUT https://spaces.nexudus.com/api/crm/taskitems

PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.

πŸ”’ Requires role "TaskItem-Edit"

Body parameters
Id: number required
The unique Id of the taskitem to update.
TaskListId: number cleared if missing
ResponsibleId: number cleared if missing
Name: string cleared if missing
Active: bool cleared if missing
NotifyByEmail: bool cleared if missing
DisplayToEveryone: bool cleared if missing
DelayInHours: int cleared if missing

Example request

PUT https://spaces.nexudus.com/api/crm/taskitems
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "Id": 12345678,
    "TaskListId": 12345678,
    "ResponsibleId": 12345678,
    "Name": "Name",
    "Active": false,
    "NotifyByEmail": false,
    "DisplayToEveryone": false,
    "DelayInHours": ,
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully updated.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Delete TaskItem

Deletes an existing taskitem by its Id.
DELETE https://spaces.nexudus.com/api/crm/taskitems/:Id

πŸ”’ Requires role "TaskItem-Delete"

URL parameters
Id: number required
The unique Id of the taskitem to update.

Example request

DELETE https://spaces.nexudus.com/api/crm/taskitems/12345678
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "The record was deleted successfully.",
    "Value": null,
    "OpenInDialog": false,
    "RedirectURL": null,
    "JavaScript": null,
    "Errors": null
}


Commands

Commands allow to perform actions against one or more taskitem records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.

Get Commands

Get all commands available to run for taskitem records.
GET https://spaces.nexudus.com/api/crm/taskitems/commands

Example request

GET https://spaces.nexudus.com/api/crm/taskitems/commands
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


[
	{
		"Key": "COMMAND_KEY_1",
		"Name": "Command 1 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": false,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": false,
		"NeedsEntitiesToRun": true,
		"Order": 2,
		"RequiresParameters": []
	},
	{
		"Key": "COMMAND_KEY_2",
		"Name": "Command 2 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": true,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": true,
		"NeedsEntitiesToRun": true,
		"Order": 10,
		"RequiresParameters": 
		[
			{
				"Name": "Parameter 1 description",
				"Type": "string",
			},
			{
				"Name": "Parameter 2 description",
				"Type": "Boolean",
			}
		]
	},
	...
]


Run Command

Runs a command based on its Key and one or more taskitem record IDs.
POST https://spaces.nexudus.com/api/crm/taskitems/runacommand
πŸ”’ Requires role "TaskItem-Edit"

Example request

POST https://spaces.nexudus.com/api/crm/taskitems/runcommand
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
	"Ids":[1329961649],
	"Parameters": 
	[
		{ 
			"Type": "string"
			"Value":987654321
		},
		{
			"Type": "Boolean",
			"Value":true
		},
		...
	],
	"Key":"COMMAND_KEY_2"
}


Example valid response


{
	"Errors": null
	"JavaScript": null
	"Message": "Result description"
	"OpenInDialog": false
	"OpenInWindow": false
	"RedirectURL": null
	"Status": 200
	"UpdatedBy": "email@example.net"
	"UpdatedOn: "2020-06-04T11:40:20Z"
	"Value: {Id: 12345678}
	"WasSuccessful: true
}


Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.