Post
/segmentation/find
Returns a paged list of selection plans (without node detail). Filter, sort and paging criteria are supplied in the request body; all fields are optional - send an empty body or to list with server defaults.
Body fields (all optional):
- page - zero-based page index (default 0).
- size - page size (default: server page size).
- sort - array of
"field,asc|desc"; the first entry is the primary key, the rest are tie-breakers. E.g."overviewCount.size,desc","createdOn,asc". - name - case-insensitive substring match on plan name.
- status - exact status, e.g.
draftorpublished. - labels - label filter.
- id - substring match on plan id.
- selectionTermId - match on the published selection term id.
- createdByName - case-insensitive substring on the creator's display name.
- createdBefore / updatedBefore / publishedBefore - ISO-8601 timestamp upper bounds.
{
"page": 0,
"size": 3,
"sort": ["overviewCount.size,desc", "createdOn,asc"],
"name": "544"
}
Body parameters
Filter, sort and paging criteria. All fields optional - send for server defaults. See the operation description for the full field list.
object
page
integer (int32)
size
integer (int32)
sort
Array of string
string
name
string
status
string
labels
string
id
string
selectionTermId
string
createdByName
string
createdBefore
string
updatedBefore
string
publishedBefore
string
Responses
200
A paged list of matching plans (without node detail).
object
segmentationSummary
Array of object (SegmentationSummary)
object
id
string
name
string
status
string
timeZoneId
string
termId
integer (int64)
labels
Array of string
string
createdBy
object (UserReference)
id
string
name
string
firstName
string
lastName
string
email
string
createdOn
string
publishedBy
object (UserReference)
id
string
name
string
firstName
string
lastName
string
email
string
publishedOn
string
updatedBy
object (UserReference)
id
string
name
string
firstName
string
lastName
string
email
string
updatedOn
string
overviewCount
integer (int64)
overviewCountStatus
string
overviewCountOn
string
number
integer (int32)
size
integer (int32)
totalElements
integer (int64)
totalPages
integer (int32)
400
bad request