Reference

Coworkernote

The coworkernote object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this coworkernote
AddedBy: string optional
CoworkerId: Id required
Notes: string required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this coworkernote
SystemId: string optional api-only
User defined data about this coworkernote. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "AddedBy": "00001",
  "CoworkerId": 12345678,
  "Notes": "00001",
  "UniqueId": "bbe189be-cbc9-4092-b68b-13ae6f7e28ba",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a CoworkerNote

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

GET https://spaces.nexudus.com/api/spaces/coworkernotes?...

πŸ”’ Requires role "CoworkerNote-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=Id
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 coworkernote records based on their different properties.
Id number
?Id=12345678
CoworkerNote_AddedBy string
?CoworkerNote_AddedBy=...
CoworkerNote_Coworker Coworker
?CoworkerNote_Coworker=...
CoworkerNote_Notes string
?CoworkerNote_Notes=...

Range search querystring parameters
Lets you search coworkernote records based on a range of date or numeric values.
To_CoworkerNote_CreatedOn date
?To_CoworkerNote_CreatedOn=2010-01-01T20:32
From_CoworkerNote_CreatedOn date
?From_CoworkerNote_CreatedOn=2010-01-01T20:32
To_CoworkerNote_UpdatedOn date
?To_CoworkerNote_UpdatedOn=2010-01-01T20:32
From_CoworkerNote_UpdatedOn date
?From_CoworkerNote_UpdatedOn=2010-01-01T20:32

Example request

GET https://spaces.nexudus.com/api/spaces/coworkernotes?CoworkerNote_Name=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Coworker": ,
        "Notes": "00001",
        "AddedBy": "00001",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "223b8a85-fa33-4bf7-8400-34a1be60020e",
        "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 CoworkerNotes by IDs

Gets one or more coworkernote records based on their Id.
GET https://spaces.nexudus.com/api/spaces/coworkernotes?CoworkerNote_Id=[:id1,:id2,...]

πŸ”’ Requires role "CoworkerNote-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Coworker": ,
        "Notes": "00001",
        "AddedBy": "00001",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "afeea78e-4691-4937-9af6-790836cfaf41",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}


Get single CoworkerNote by Id

Gets one coworkernote record by its Id.
GET https://spaces.nexudus.com/api/spaces/coworkernotes/:Id

πŸ”’ Requires role "CoworkerNote-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "AddedBy": "00001",
  "CoworkerId": 12345678,
  "Notes": "00001",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "62040a52-e815-46e1-9fa4-e5febf9315ac",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new CoworkerNote

Creates a new coworkernote.
POST https://spaces.nexudus.com/api/spaces/coworkernotes

πŸ”’ Requires role "CoworkerNote-Create"

Body parameters
CoworkerId: number required
Notes: string required
AddedBy: string optional

Example request

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

{
    "CoworkerId": 12345678,
    "Notes": "00001",
    "AddedBy": "00001",
}


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 CoworkerNote

Updates an existing coworkernote.
PUT https://spaces.nexudus.com/api/spaces/coworkernotes

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

πŸ”’ Requires role "CoworkerNote-Edit"

Body parameters
Id: number required
The unique Id of the coworkernote to update.
CoworkerId: number cleared if missing
Notes: string cleared if missing
AddedBy: string cleared if missing

Example request

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

{
    "Id": 12345678,
    "CoworkerId": 12345678,
    "Notes": "00001",
    "AddedBy": "00001",
}


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 CoworkerNote

Deletes an existing coworkernote by its Id.
DELETE https://spaces.nexudus.com/api/spaces/coworkernotes/:Id

πŸ”’ Requires role "CoworkerNote-Delete"

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

Example request

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

Example request

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

Example request

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