resources/segments/search/item/{segmentid}

Permits to find segments by a wide range of criteria.

(POST) /api/resources/segments/search/item/{segmentid}

The URL parameter is contains the segment ID to fetch.

segmentid

The ID of the segment to fetch.

Mandatory, int

The message body contains a JSON object with these properties.

scope	The scope object. It delimits the total range of segments and related resources that can be queried. Example: "scope": { "type": "Project", "projectid": 1234 }	Mandatory, object
usecache	Optional boolean, default is true. Set to false only if there is a possibility that user access rights have changed. False enforces the system to recalculate all access rights for the specified scope.	Optional, bool?
includeRights	Default: false true: Includes full scope/rights details with the results (result.rights) false: Do not include rights with results. Instead the result.rights node will be null. Use false when possible to reduce http response size.	Optional, bool?
includeLayout	Default: false true: Always include the layout for the results. false: Include the layout with the result only if the API method was called without a layout Use false when possible to reduce http response size.	Optional, bool?

The message body contains a JSON object:

result.rows	An array with a single element, which is the segment's properties. See resources/segments/search for details on this object.	object[]
result.docs	A dictionary with all documents that appear in the results. See resources/segments/search for details on this object.	object
result.users	A dictionary with all users/persons that are referenced by the segments included with the results. See resources/segments/search for details on this object.	object

	RIGHTS AND LAYOUT
layout	Optional. Populated if includeLayout* parameter is explicitly set to true.* The layout object. The layout passed to the API method or a default layout. The layout is "cleaned" in that columns not visible to the current user will be removed. See Spreadsheet Layout (Object) for full details.	object
rights	Optional. Populated if includeRights parameter is explicitly set to true. The rights object. It provides very granular information on: The user's access rights. There are properties that tell if a user can do certain actions or not. Additional scope details Comments attached on scope level Label properties Custom field properties See Rights (Object) for full details.	object

N/A