Documentation

task.commentitem.getlist

Returns list of comments to a task.

Method parameters

ParameterDescription
TASKID Task ID. A required parameter.
ORDER Array for result sorting. The field for sorting may take the following values:
  • ID – comment ID;
  • AUTHOR_ID – comment author’s identifier;
  • AUTHOR_NAME – author’s name;
  • AUTHOR_EMAIL – author’s email ;
  • POST_DATE – comment posting date..
The sorting direction may take the following values:
  • asc – ascending;
  • desc – descending;
Optional. By default it is filtered by descending comment ID.
FILTER The array of the type {"filtered_field": "field value" [, ...]}. Filtered field can take the following values:
  • ID – comment ID;
  • AUTHOR_ID – ID of a comment author;
  • AUTHOR_NAME – author’s name;
  • POST_DATE – comment posting date.
Filter type can be specified before the filtered field:
  • "!" – not equal;
  • "<" – less;
  • "<=" – less or equal;
  • ">" – more;
  • ">=" – more or equal.
filter values – a single value or an array.

Optional. By default the entries are not filtered.

Attention! Compliance to parameter sequence in the request is mandatory. If sequence is not observed, the request will be completed with errors.

Example

// Obtain all the comments for the task with ID=1 with ascending sorting by ID and filter by AUTHOR_ID

BX24.callMethod(
	'task.commentitem.getlist',
	[1, {'ID': 'asc'}, {'>AUTHOR_ID': 2}],
	function(result){
		console.info(result.data());
		console.log(result);
	}
);


© «Bitrix Inc.», 2001-2018, «Bitrix Inc.», 2018