API Members Portal Email Support Request a Demo
Submit a request
  1. Nexudus
  2. API
  3. Crm

Reference

Crmopportunityimportfile

The crmopportunityimportfile object

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

Json Structure Example 


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "Imported": false,
  "Name": "Joe",
  "UniqueId": "48dc97ca-fec0-466c-ae85-7c89e05f9de6",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Find a CrmOpportunityImportFile

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

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

🔒 Requires role "CrmOpportunityImportFile-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 crmopportunityimportfile records based on their different properties.
Id number
?Id=12345678
CrmOpportunityImportFile_Business Business
?CrmOpportunityImportFile_Business=...
CrmOpportunityImportFile_Imported bool
?CrmOpportunityImportFile_Imported=...
CrmOpportunityImportFile_Name string
?CrmOpportunityImportFile_Name=...

Range search querystring parameters
Lets you search crmopportunityimportfile records based on a range of date or numeric values.
To_CrmOpportunityImportFile_CreatedOn date
?To_CrmOpportunityImportFile_CreatedOn=2010-01-01T20:32
From_CrmOpportunityImportFile_CreatedOn date
?From_CrmOpportunityImportFile_CreatedOn=2010-01-01T20:32
To_CrmOpportunityImportFile_UpdatedOn date
?To_CrmOpportunityImportFile_UpdatedOn=2010-01-01T20:32
From_CrmOpportunityImportFile_UpdatedOn date
?From_CrmOpportunityImportFile_UpdatedOn=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "Joe",
        "Imported": false,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "956ba392-1ccf-4f73-9b1c-7e16ae68ad7b",
        "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 CrmOpportunityImportFiles by IDs

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

🔒 Requires role "CrmOpportunityImportFile-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "Joe",
        "Imported": false,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "48ca984d-7579-4250-a82e-db5338124b53",
        "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 CrmOpportunityImportFile by Id

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

🔒 Requires role "CrmOpportunityImportFile-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "Imported": false,
  "Name": "Joe",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "0ca60251-2bda-4452-8cb0-9314b696140a",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Create new CrmOpportunityImportFile

Creates a new crmopportunityimportfile. 
POST https://spaces.nexudus.com/api/crm/crmopportunityimportfiles

🔒 Requires role "CrmOpportunityImportFile-Create"

Body parameters
BusinessId: number required
Name: string required
Imported: bool optional

Example request

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


{
    "BusinessId": 12345678,
    "Name": "Joe",
    "Imported": 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 CrmOpportunityImportFile

Updates an existing crmopportunityimportfile. 
PUT https://spaces.nexudus.com/api/crm/crmopportunityimportfiles

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

🔒 Requires role "CrmOpportunityImportFile-Edit"

Body parameters
Id: number required
The unique Id of the crmopportunityimportfile to update.
BusinessId: number cleared if missing
Name: string cleared if missing
Imported: bool cleared if missing

Example request

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


{
    "Id": 12345678,
    "BusinessId": 12345678,
    "Name": "Joe",
    "Imported": 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 CrmOpportunityImportFile

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

🔒 Requires role "CrmOpportunityImportFile-Delete"

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

Example request

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

Example request

GET https://spaces.nexudus.com/api/crm/crmopportunityimportfiles/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 crmopportunityimportfile record IDs. 
POST https://spaces.nexudus.com/api/crm/crmopportunityimportfiles/runacommand
🔒 Requires role "CrmOpportunityImportFile-Edit"

Example request

POST https://spaces.nexudus.com/api/crm/crmopportunityimportfiles/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/crm/crmopportunityimportfiles/getfiledata/:id
URL parameters
Id: number required
The id of the CrmOpportunityImportFile to get the filedata 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.