Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Gets list of all people who may be interested in a segment or document level comment.

This includes people who have a job, who are project manager, who have edited texts in the same document and language of the comment.

URL

(POST) /resources/team/comment

PARAMETERS

The parameters are a JSON object included in the request body:

scope

The scope object. Note that if you use a document set or global search scope, you will receive an "available" = false result. In fact these scopes do not support files.

Mandatory
cmidThe comment id. See the API methods for fetching comments for more details.Mandatory


RESULTS

The result is a JSON object:

membersAn array of members, See member object below.array<object>

 

Each member has these properties:

cidThe company id of the member.int

cnm

Company name

string
uidThe user/person id. If the member is the company and not a specific user then the value is null.int?
unmThe user/person name. If the member is the company and not a specific user then the value is null.string?
role

A localized text that explains the exact role of the person, for example:

  • Translation English to French
  • Project manager
  • Editor
  • ...
string

 

Note: The mechanism for obtaining team members depend on the scope. For project and job scopes, the system looks for jobs and the project manager. For document set, resource and global search scopes members include only the people who have done text edits.

 

 

  • No labels