Reference

Coworkerdatafile

The coworkerdatafile object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this coworkerdatafile
AvailableToUser: bool optional
BusinessId: Id required
CoworkerId: Id required
Description: string optional
Name: string required
RequestDigitalSignature: bool optional
Signed: bool optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this coworkerdatafile
SystemId: string optional api-only
User defined data about this coworkerdatafile. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "AvailableToUser": false,
  "BusinessId": 12345678,
  "CoworkerId": 12345678,
  "Description": "Abc123456",
  "Name": "00001",
  "RequestDigitalSignature": false,
  "Signed": false,
  "UniqueId": "6fff2e6a-0c7b-4302-a7f3-75710cfe78d0",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a CoworkerDataFile

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

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

πŸ”’ Requires role "CoworkerDataFile-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 coworkerdatafile records based on their different properties.
Id number
?Id=12345678
CoworkerDataFile_AvailableToUser bool
?CoworkerDataFile_AvailableToUser=...
CoworkerDataFile_Business Business
?CoworkerDataFile_Business=...
CoworkerDataFile_Coworker Coworker
?CoworkerDataFile_Coworker=...
CoworkerDataFile_Description string
?CoworkerDataFile_Description=...
CoworkerDataFile_Name string
?CoworkerDataFile_Name=...
CoworkerDataFile_RequestDigitalSignature bool
?CoworkerDataFile_RequestDigitalSignature=...
CoworkerDataFile_Signed bool
?CoworkerDataFile_Signed=...

Range search querystring parameters
Lets you search coworkerdatafile records based on a range of date or numeric values.
To_CoworkerDataFile_CreatedOn date
?To_CoworkerDataFile_CreatedOn=2010-01-01T20:32
From_CoworkerDataFile_CreatedOn date
?From_CoworkerDataFile_CreatedOn=2010-01-01T20:32
To_CoworkerDataFile_UpdatedOn date
?To_CoworkerDataFile_UpdatedOn=2010-01-01T20:32
From_CoworkerDataFile_UpdatedOn date
?From_CoworkerDataFile_UpdatedOn=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Coworker": ,
        "Name": "00001",
        "Description": "Abc123456",
        "AvailableToUser": false,
        "RequestDigitalSignature": false,
        "Signed": false,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "ecb163fc-96e1-4671-8313-05526a16553e",
        "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 CoworkerDataFiles by IDs

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

πŸ”’ Requires role "CoworkerDataFile-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Coworker": ,
        "Name": "00001",
        "Description": "Abc123456",
        "AvailableToUser": false,
        "RequestDigitalSignature": false,
        "Signed": false,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "ce4eb0d2-7587-4236-9e66-ba053eb32ccd",
        "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 CoworkerDataFile by Id

Gets one coworkerdatafile record by its Id.
GET https://spaces.nexudus.com/api/spaces/coworkerdatafiles/:Id

πŸ”’ Requires role "CoworkerDataFile-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "AvailableToUser": false,
  "BusinessId": 12345678,
  "CoworkerId": 12345678,
  "Description": "Abc123456",
  "Name": "00001",
  "RequestDigitalSignature": false,
  "Signed": false,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "df4ba11b-c1a6-4c91-baa8-08cc3b7899b6",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new CoworkerDataFile

Creates a new coworkerdatafile.
POST https://spaces.nexudus.com/api/spaces/coworkerdatafiles

πŸ”’ Requires role "CoworkerDataFile-Create"

Body parameters
BusinessId: number required
CoworkerId: number required
Name: string required
Description: string optional
AvailableToUser: bool optional
RequestDigitalSignature: bool optional
Signed: bool optional

Example request

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

{
    "BusinessId": 12345678,
    "CoworkerId": 12345678,
    "Name": "00001",
    "Description": "Abc123456",
    "AvailableToUser": false,
    "RequestDigitalSignature": false,
    "Signed": 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 CoworkerDataFile

Updates an existing coworkerdatafile.
PUT https://spaces.nexudus.com/api/spaces/coworkerdatafiles

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

πŸ”’ Requires role "CoworkerDataFile-Edit"

Body parameters
Id: number required
The unique Id of the coworkerdatafile to update.
BusinessId: number cleared if missing
CoworkerId: number cleared if missing
Name: string cleared if missing
Description: string cleared if missing
AvailableToUser: bool cleared if missing
RequestDigitalSignature: bool cleared if missing
Signed: bool cleared if missing

Example request

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

{
    "Id": 12345678,
    "BusinessId": 12345678,
    "CoworkerId": 12345678,
    "Name": "00001",
    "Description": "Abc123456",
    "AvailableToUser": false,
    "RequestDigitalSignature": false,
    "Signed": 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 CoworkerDataFile

Deletes an existing coworkerdatafile by its Id.
DELETE https://spaces.nexudus.com/api/spaces/coworkerdatafiles/:Id

πŸ”’ Requires role "CoworkerDataFile-Delete"

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

Example request

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

Example request

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

Example request

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


Binary files

The following endpoints return binary data. Check the `ContentType` header to understand the type of file being returned in the response stream.

FileData

GET https://spaces.nexudus.com/api/spaces/coworkerdatafiles/getfiledata/:id
URL parameters
Id: number required
The id of the CoworkerDataFile to get the filedata for.

SignedFileData

GET https://spaces.nexudus.com/api/spaces/coworkerdatafiles/getsignedfiledata/:id
URL parameters
Id: number required
The id of the CoworkerDataFile to get the signedfiledata for.

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.