Reference

Coworkertask

The coworkertask object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this coworkertask
BusinessId: Id required
Completed: bool optional
CoworkerId: Id required
DisplayToEveryone: bool optional
DueDate: DateTime? optional
Name: string required
Notes: string optional
NotifyByEmail: bool optional
ResponsibleId: Id required
TaskListName: string optional read-only
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this coworkertask
SystemId: string optional api-only
User defined data about this coworkertask. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "Completed": false,
  "CoworkerId": 12345678,
  "DisplayToEveryone": false,
  "DueDate": ,
  "Name": "00001",
  "Notes": "Notes",
  "NotifyByEmail": false,
  "ResponsibleId": 12345678,
  "TaskListName": "null",
  "UniqueId": "3750f60e-ba8a-46d6-b30b-182b50bdf0fa",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a CoworkerTask

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

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

πŸ”’ Requires role "CoworkerTask-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=DueDate
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 coworkertask records based on their different properties.
Id number
?Id=12345678
CoworkerTask_Business Business
?CoworkerTask_Business=...
CoworkerTask_Completed bool
?CoworkerTask_Completed=...
CoworkerTask_Coworker Coworker
?CoworkerTask_Coworker=...
CoworkerTask_DisplayToEveryone bool
?CoworkerTask_DisplayToEveryone=...
CoworkerTask_DueDate DateTime?
?CoworkerTask_DueDate=...
CoworkerTask_Name string
?CoworkerTask_Name=...
CoworkerTask_Notes string
?CoworkerTask_Notes=...
CoworkerTask_NotifyByEmail bool
?CoworkerTask_NotifyByEmail=...
CoworkerTask_Responsible User
?CoworkerTask_Responsible=...
CoworkerTask_TaskListName string
?CoworkerTask_TaskListName=...
CoworkerTask_CoworkerFullName string
?CoworkerTask_CoworkerFullName=...
CoworkerTask_ResponsibleFullName string
?CoworkerTask_ResponsibleFullName=...

Range search querystring parameters
Lets you search coworkertask records based on a range of date or numeric values.
To_CoworkerTask_CreatedOn date
?To_CoworkerTask_CreatedOn=2010-01-01T20:32
From_CoworkerTask_CreatedOn date
?From_CoworkerTask_CreatedOn=2010-01-01T20:32
To_CoworkerTask_UpdatedOn date
?To_CoworkerTask_UpdatedOn=2010-01-01T20:32
From_CoworkerTask_UpdatedOn date
?From_CoworkerTask_UpdatedOn=2010-01-01T20:32
To_CoworkerTask_DueDate date
?To_CoworkerTask_DueDate=2010-01-01T20:32
From_CoworkerTask_DueDate date
?From_CoworkerTask_DueDate=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Coworker": ,
        "Name": "00001",
        "Notes": "Notes",
        "TaskListName": "null",
        "Completed": false,
        "DueDate": ,
        "Responsible": ,
        "NotifyByEmail": false,
        "DisplayToEveryone": false,
        "CoworkerTaskCoworkerFullName": "...",
        "CoworkerTaskResponsibleFullName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "6e73c3e3-c1e3-42a3-9ff5-ecd94cb4689c",
        "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 CoworkerTasks by IDs

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

πŸ”’ Requires role "CoworkerTask-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Coworker": ,
        "Name": "00001",
        "Notes": "Notes",
        "TaskListName": "null",
        "Completed": false,
        "DueDate": ,
        "Responsible": ,
        "NotifyByEmail": false,
        "DisplayToEveryone": false,
        "CoworkerTaskCoworkerFullName": "...",
        "CoworkerTaskResponsibleFullName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "84367929-80fb-4204-bc22-b7a79406b96a",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "DueDate",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}


Get single CoworkerTask by Id

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

πŸ”’ Requires role "CoworkerTask-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "Completed": false,
  "CoworkerId": 12345678,
  "DisplayToEveryone": false,
  "DueDate": ,
  "Name": "00001",
  "Notes": "Notes",
  "NotifyByEmail": false,
  "ResponsibleId": 12345678,
  "TaskListName": "null",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "f33d2442-06cc-49ee-a057-f9540fa3008f",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new CoworkerTask

Creates a new coworkertask.
POST https://spaces.nexudus.com/api/crm/coworkertasks

πŸ”’ Requires role "CoworkerTask-Create"

Body parameters
BusinessId: number required
CoworkerId: number required
Name: string required
Notes: string optional
Completed: bool optional
DueDate: DateTime? optional
ResponsibleId: number required
NotifyByEmail: bool optional
DisplayToEveryone: bool optional

Example request

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

{
    "BusinessId": 12345678,
    "CoworkerId": 12345678,
    "Name": "00001",
    "Notes": "Notes",
    "Completed": false,
    "DueDate": ,
    "ResponsibleId": 12345678,
    "NotifyByEmail": false,
    "DisplayToEveryone": false,
}


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 CoworkerTask

Updates an existing coworkertask.
PUT https://spaces.nexudus.com/api/crm/coworkertasks

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

πŸ”’ Requires role "CoworkerTask-Edit"

Body parameters
Id: number required
The unique Id of the coworkertask to update.
BusinessId: number cleared if missing
CoworkerId: number cleared if missing
Name: string cleared if missing
Notes: string cleared if missing
Completed: bool cleared if missing
DueDate: DateTime? cleared if missing
ResponsibleId: number cleared if missing
NotifyByEmail: bool cleared if missing
DisplayToEveryone: bool cleared if missing

Example request

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

{
    "Id": 12345678,
    "BusinessId": 12345678,
    "CoworkerId": 12345678,
    "Name": "00001",
    "Notes": "Notes",
    "Completed": false,
    "DueDate": ,
    "ResponsibleId": 12345678,
    "NotifyByEmail": false,
    "DisplayToEveryone": false,
}


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 CoworkerTask

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

πŸ”’ Requires role "CoworkerTask-Delete"

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

Example request

DELETE https://spaces.nexudus.com/api/crm/coworkertasks/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 coworkertask 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 coworkertask records.
GET https://spaces.nexudus.com/api/crm/coworkertasks/commands

Example request

GET https://spaces.nexudus.com/api/crm/coworkertasks/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 coworkertask record IDs.
POST https://spaces.nexudus.com/api/crm/coworkertasks/runacommand
πŸ”’ Requires role "CoworkerTask-Edit"

Example request

POST https://spaces.nexudus.com/api/crm/coworkertasks/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.