Versions Compared

Old Version 3

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Stephan Böhmig

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Use this method to enumerate or find segments. It returns full segment details for up to two languages (you can specify). If a segment is multilingual you need to call the method "projects/{projectid}/documents/{documentid}/segments/{segment}" to retrieve the complete information with all languages.

URL

(GET) resources/{resourceid}/segments

PARAMETERS

Token

The token obtained on connection

Required

Resourceid

The unique resource identifier

Required

From

The first record to show starting with index 0. Default is 0

Optional

Count

The number of records to show, up to 1000 at a time. Default is 1000.

Optional

locale1

An optional locale. If set then the method returns the text in this locale.

Example: "locale1=en"

Required

locale2

An optional locale. If set then the method returns the text in this locale.

Example: "locale2=de"

Optional

Filter

A json which contains the filter details.

Optional

 

JSON format of "data" parameter

 

CustomFields

A json array containing a list of custom field ids and values. See below for details.

Example:

Code Block
[ {
	"Id": "CustomStr1", 
	"Value": "My field" 
}, 
{ 
	"Id": "CustomStr5", 
	"Value": "A-2233" 
} ]
Optional

 

JSON format of field "CustomFields"

 

IdThe custom string id such as 'CustomStr1', 'CustomStr2', etc. Use method settings/customfields to obtain all available ids. Note that custom fields may apply to clients only, suppliers only or both (check out the configuration of custom fields in your Wordbee platform).Required
ValueThe value (string) of the custom fieldRequired

 

RESULTS

Returns a list of ApiSegment items.