DocumentsController

Base route: crm/documents

Namespace	Axiom.App.Crm.Api.Controllers
Base Route	`crm/documents`
Security	SalesProfessional, SalesEssential

Endpoints

Method	Route	Method Name	Parameters	Return Type
Get	`crm/documents/lists/{id:int}`	Get	id: int, searchText: string, skip: int, limit: int, tags: List<string>, orderBy: string, direction: string, filters: string	`List`
Get	`crm/documents/export/{documentListId:int}`	Export	documentListId: int, includeAllFields: bool, csv: bool	`IActionResult`
Get	`crm/documents/form/{form}/`	GetForm	form: string	`DocumentForm`
Put	`crm/documents`	Put	document: Document	`bool`
Post	`crm/documents`	Post	document: Document	`int`
Post	`crm/documents/deleteselected`	DeleteSelected	selectedIds: List<int>	`bool`
Delete	`crm/documents/{documentId:int}`	Delete	documentId: int	`bool`
Post	`crm/documents/filesystem`	PostFileSystem	document: Document	`bool`
Put	`crm/documents/sortorder/{documentListId:int}`	SortOrder	filtersort: Sort, documentListId: int	`bool`
Put	`crm/documents/filterdata/{documentListId:int}`	FilterData	filterData: List<FilterData>, documentListId: int	`bool`
Put	`crm/documents/fields/{documentListId:int}`	Fields	updatedFields: List<string>, documentListId: int	`bool`
Put	`crm/documents/tags/{documentListId:int}`	Tags	tags: List<string>, documentListId: int	`bool`
Post	`crm/documents/merge`	Merge	documentMergeViewModel: DocumentMergeViewModel	`bool`

Detailed Endpoint Information

Get crm/documents/lists/{id:int} Get

Return Type

List

Parameters

Name	Type	Source	Optional
`id`	`int`	Query	No
`searchText`	`string`	Query	No
`skip`	`int`	Query	No
`limit`	`int`	Query	No
`tags`	`List<string>`	FromQuery	No
`orderBy`	`string`	Query	No
`direction`	`string`	Query	No
`filters`	`string`	Query	No

Get crm/documents/export/{documentListId:int} Export

Return Type

IActionResult

Parameters

Name	Type	Source	Optional
`documentListId`	`int`	Query	No
`includeAllFields`	`bool`	Query	No
`csv`	`bool`	Query	No

Get crm/documents/form/{form}/ GetForm

Return Type

DocumentForm

Parameters

Name	Type	Source	Optional
`form`	`string`	Query	No

Put crm/documents Put

Return Type

bool

Parameters

Name	Type	Source	Optional
`document`	`Document`	FromBody	No

Post crm/documents Post

Return Type

int

Parameters

Name	Type	Source	Optional
`document`	`Document`	FromBody	No

Post crm/documents/deleteselected DeleteSelected

Return Type

bool

Parameters

Name	Type	Source	Optional
`selectedIds`	`List<int>`	FromBody	No

Delete crm/documents/{documentId:int} Delete

Return Type

bool

Parameters

Name	Type	Source	Optional
`documentId`	`int`	Query	No

Post crm/documents/filesystem PostFileSystem

Return Type

bool

Parameters

Name	Type	Source	Optional
`document`	`Document`	FromBody	No

Put crm/documents/sortorder/{documentListId:int} SortOrder

Return Type

bool

Parameters

Name	Type	Source	Optional
`filtersort`	`Sort`	FromBody	No
`documentListId`	`int`	Query	No

Put crm/documents/filterdata/{documentListId:int} FilterData

Return Type

bool

Parameters

Name	Type	Source	Optional
`filterData`	`List<FilterData>`	FromBody	No
`documentListId`	`int`	Query	No

Put crm/documents/fields/{documentListId:int} Fields

Return Type

bool

Parameters

Name	Type	Source	Optional
`updatedFields`	`List<string>`	FromBody	No
`documentListId`	`int`	Query	No

Put crm/documents/tags/{documentListId:int} Tags

Return Type

bool

Parameters

Name	Type	Source	Optional
`tags`	`List<string>`	FromBody	No
`documentListId`	`int`	Query	No

Post crm/documents/merge Merge

Return Type

bool

Parameters

Name	Type	Source	Optional
`documentMergeViewModel`	`DocumentMergeViewModel`	FromBody	No