User Tools
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
en:devel:corebosws:getrelatedrecords [2020/12/27 13:54] joebordes [Web service get Related Records method] |
en:devel:corebosws:getrelatedrecords [2021/03/03 13:49] (current) joebordes [Web service get Related Records method] |
||
|---|---|---|---|
| Line 25: | Line 25: | ||
| * ProductLineSalesOrder{Only}: relation Account|Contact-Products, return products related through SalesOrder (only) | * ProductLineSalesOrder{Only}: relation Account|Contact-Products, return products related through SalesOrder (only) | ||
| * ProductLineQuote{Only}: relation Account|Contact-Products, return products related through Quote (only) | * ProductLineQuote{Only}: relation Account|Contact-Products, return products related through Quote (only) | ||
| - | * ProductLineAll: relation Account|Contact-Products, return products related through Quote, SalesOrder and Invoice | + | * ProductLineAll: relation Account|Contact-Products, return products related through Quote, SalesOrder, and Invoice |
| * ProductLineNone: relation Account|Contact-Products, return only products directly related, this is the default behavior | * ProductLineNone: relation Account|Contact-Products, return only products directly related, this is the default behavior | ||
| * **limit**: a string indicating the limit of records to be returned. this is needed for paging | * **limit**: a string indicating the limit of records to be returned. this is needed for paging | ||
| Line 32: | Line 32: | ||
| * **columns**: a comma separated string of column names that are to be returned. The special value "*" will return all fields. for example: 'assigned_user_id,id,createdtime,notes_title,filedownloadcount,filelocationtype,filesize' | * **columns**: a comma separated string of column names that are to be returned. The special value "*" will return all fields. for example: 'assigned_user_id,id,createdtime,notes_title,filedownloadcount,filelocationtype,filesize' | ||
| * **relationtouse**: label of the relation to select when more than one is found, if not given, or not found an exception will be thrown. when two modules are related by more than one function, the code does not know which one to use, in that case, it will throw an exception. Using this parameter you can tell the code which of the various relations you want to use. You must set the parameter to the internal (untranslated) label of the relation (vtiger_relatedlists.label) | * **relationtouse**: label of the relation to select when more than one is found, if not given, or not found an exception will be thrown. when two modules are related by more than one function, the code does not know which one to use, in that case, it will throw an exception. Using this parameter you can tell the code which of the various relations you want to use. You must set the parameter to the internal (untranslated) label of the relation (vtiger_relatedlists.label) | ||
| + | * **returnattachments**: for Document module will return the file attached if present | ||
| * **returns** an array where each element represents a web service record of the type of the related module. Only the columns and records the current user has access to will be returned. If the current user cannot access the main module or the related module, an error will be returned. | * **returns** an array where each element represents a web service record of the type of the related module. Only the columns and records the current user has access to will be returned. If the current user cannot access the main module or the related module, an error will be returned. | ||
