Segment - Lookup

GET

/segments/v2/{bucket}/segment/{uid}/lookup

Lookup a record within a segment using a simple single search term

Parameters

Path Parameters

bucket

required

The bucket (client) name

string

Example

example

uid

required

Usually the final element in the URI, an alphanumeric unique identifier

string

Example

6305f074683e800f3abe809e

Query Parameters

q

Usually the final element in the URI, an alphanumeric unique identifier

string

Example

6305f074683e800f3abe809e

Responses

200

A list of segments matching the search terms

Array<object>

object

display_value

The human readable value of the record the URI points to

string

id

URIs are unique identifiers for resources in the system, they are structured as follows /bucket/resource_type/uid/

string

Example

/example/person/6305f074683e800f3abe809e/

label

string

text

string

uri

URIs are unique identifiers for resources in the system, they are structured as follows /bucket/resource_type/uid/

string

Example

/example/person/6305f074683e800f3abe809e/

value

URIs are unique identifiers for resources in the system, they are structured as follows /bucket/resource_type/uid/

string

Example

/example/person/6305f074683e800f3abe809e/

400

A standard error message

object

description

A human readable description of the error

string

error

A concise error message

string

type

A machine readable error type

string

401

Authentication error