Reference

Crmopportunityhistory

The crmopportunityhistory object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this crmopportunityhistory
CrmOpportunityId: Id optional
FromTime: DateTime? optional
NewCrmBoardColumnId: Id required
OldCrmBoardColumnId: Id optional
ToTime: DateTime? optional
UserId: Id optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this crmopportunityhistory
SystemId: string optional api-only
User defined data about this crmopportunityhistory. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "CrmOpportunityId": 12345678,
  "FromTime": ,
  "NewCrmBoardColumnId": 12345678,
  "OldCrmBoardColumnId": 12345678,
  "ToTime": ,
  "UserId": 12345678,
  "UniqueId": "46e66c08-42e0-49e3-846d-acfee2ed5f2b",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a CrmOpportunityHistory

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

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

πŸ”’ Requires role "CrmOpportunityHistory-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 crmopportunityhistory records based on their different properties.
Id number
?Id=12345678
CrmOpportunityHistory_CrmOpportunity CrmOpportunity
?CrmOpportunityHistory_CrmOpportunity=...
CrmOpportunityHistory_FromTime DateTime?
?CrmOpportunityHistory_FromTime=...
CrmOpportunityHistory_NewCrmBoardColumn CrmBoardColumn
?CrmOpportunityHistory_NewCrmBoardColumn=...
CrmOpportunityHistory_OldCrmBoardColumn CrmBoardColumn
?CrmOpportunityHistory_OldCrmBoardColumn=...
CrmOpportunityHistory_ToTime DateTime?
?CrmOpportunityHistory_ToTime=...
CrmOpportunityHistory_User User
?CrmOpportunityHistory_User=...
CrmOpportunityHistory_CrmOpportunityId string
?CrmOpportunityHistory_CrmOpportunityId=...
CrmOpportunityHistory_OldCrmBoardColumnName string
?CrmOpportunityHistory_OldCrmBoardColumnName=...
CrmOpportunityHistory_NewCrmBoardColumnName string
?CrmOpportunityHistory_NewCrmBoardColumnName=...
CrmOpportunityHistory_UserFullName string
?CrmOpportunityHistory_UserFullName=...

Range search querystring parameters
Lets you search crmopportunityhistory records based on a range of date or numeric values.
To_CrmOpportunityHistory_CreatedOn date
?To_CrmOpportunityHistory_CreatedOn=2010-01-01T20:32
From_CrmOpportunityHistory_CreatedOn date
?From_CrmOpportunityHistory_CreatedOn=2010-01-01T20:32
To_CrmOpportunityHistory_UpdatedOn date
?To_CrmOpportunityHistory_UpdatedOn=2010-01-01T20:32
From_CrmOpportunityHistory_UpdatedOn date
?From_CrmOpportunityHistory_UpdatedOn=2010-01-01T20:32
To_CrmOpportunityHistory_FromTime date
?To_CrmOpportunityHistory_FromTime=2010-01-01T20:32
From_CrmOpportunityHistory_FromTime date
?From_CrmOpportunityHistory_FromTime=2010-01-01T20:32
To_CrmOpportunityHistory_ToTime date
?To_CrmOpportunityHistory_ToTime=2010-01-01T20:32
From_CrmOpportunityHistory_ToTime date
?From_CrmOpportunityHistory_ToTime=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "CrmOpportunity": ,
        "OldCrmBoardColumn": ,
        "FromTime": ,
        "ToTime": ,
        "NewCrmBoardColumn": ,
        "User": ,
        "CrmOpportunityHistoryCrmOpportunityId": "...",
        "CrmOpportunityHistoryOldCrmBoardColumnName": "...",
        "CrmOpportunityHistoryNewCrmBoardColumnName": "...",
        "CrmOpportunityHistoryUserFullName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "7450f2d6-3459-4eb3-bb1b-7e0b6d0f12bc",
        "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 CrmOpportunityHistories by IDs

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

πŸ”’ Requires role "CrmOpportunityHistory-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "CrmOpportunity": ,
        "OldCrmBoardColumn": ,
        "FromTime": ,
        "ToTime": ,
        "NewCrmBoardColumn": ,
        "User": ,
        "CrmOpportunityHistoryCrmOpportunityId": "...",
        "CrmOpportunityHistoryOldCrmBoardColumnName": "...",
        "CrmOpportunityHistoryNewCrmBoardColumnName": "...",
        "CrmOpportunityHistoryUserFullName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "f215fcf5-b01e-4a90-8344-00cbec4db53c",
        "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 CrmOpportunityHistory by Id

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

πŸ”’ Requires role "CrmOpportunityHistory-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "CrmOpportunityId": 12345678,
  "FromTime": ,
  "NewCrmBoardColumnId": 12345678,
  "OldCrmBoardColumnId": 12345678,
  "ToTime": ,
  "UserId": 12345678,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "15904362-fe98-4f60-95c3-13d4705dc6e9",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new CrmOpportunityHistory

Creates a new crmopportunityhistory.
POST https://spaces.nexudus.com/api/crm/crmopportunityhistories

πŸ”’ Requires role "CrmOpportunityHistory-Create"

Body parameters
CrmOpportunityId: number optional
OldCrmBoardColumnId: number optional
FromTime: DateTime? optional
ToTime: DateTime? optional
NewCrmBoardColumnId: number required
UserId: number optional

Example request

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

{
    "CrmOpportunityId": 12345678,
    "OldCrmBoardColumnId": 12345678,
    "FromTime": ,
    "ToTime": ,
    "NewCrmBoardColumnId": 12345678,
    "UserId": 12345678,
}


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 CrmOpportunityHistory

Updates an existing crmopportunityhistory.
PUT https://spaces.nexudus.com/api/crm/crmopportunityhistories

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

πŸ”’ Requires role "CrmOpportunityHistory-Edit"

Body parameters
Id: number required
The unique Id of the crmopportunityhistory to update.
CrmOpportunityId: number cleared if missing
OldCrmBoardColumnId: number cleared if missing
FromTime: DateTime? cleared if missing
ToTime: DateTime? cleared if missing
NewCrmBoardColumnId: number cleared if missing
UserId: number cleared if missing

Example request

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

{
    "Id": 12345678,
    "CrmOpportunityId": 12345678,
    "OldCrmBoardColumnId": 12345678,
    "FromTime": ,
    "ToTime": ,
    "NewCrmBoardColumnId": 12345678,
    "UserId": 12345678,
}


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 CrmOpportunityHistory

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

πŸ”’ Requires role "CrmOpportunityHistory-Delete"

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

Example request

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

Example request

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

Example request

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