/
resources/segments/rights

resources/segments/rights

This method provides information if and how a user can access segments in the given scope . A scope can be a job, project, global search, a translation memory and so on.

Gives full answers to:

  • Can the user access segments in the scope in the first place? For example, a translator most often cannot access the segments in a project.
  • What are the accessible languages, segment fields, custom fields, labels, etc?
  • Which editing operations are allowed? Can I edit texts, meta information, split/merge etc?
  • What are the languages with code and name, custom field codes and names and so on?

This information can be used if you build a translation editing interface and you need to know in advance what information the user can access and modify. 

URL

(POST) /api/resources/segments/rights

PARAMETERS

The message body contains a JSON object:

BODY

The scope json object. For example, for a job, project, memory, term base, global search etc.

Example for a job:

{ "type": "Job", "jobid": 18422, "jobcdyt": true }

Example for a project:

{ "type": "Project", "projectid": 229 } 

See Scope (Object) for more details.

object, Mandatory


RESULTS

The method returns all the information for the scope.

See Rights (Object)


ACCESS RIGHTS

Requesting information for a scope the user is not authorized to access at all, will return an error.

For example, an external translator will not be able to obtain information for a project-scope. He/She may get information for authorized jobs only (such as assigned jobs).




Related content

Scope (Object)
Scope (Object)
More like this
resources/files/details
resources/files/details
More like this
Error handling and code
Error handling and code
Read with this
Rights (Object)
Rights (Object)
More like this
Search and filter segments
Search and filter segments
Read with this
resources/segments/finder/properties
resources/segments/finder/properties
More like this

Copyright Wordbee - Buzzin' Outside the Box since 2008