Versions Compared

Key

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

This object can be specify the sort of results.

...

Table of Contents

STRUCTURE

Code Block
{
 "key":"DocumentId", // Type of sort
 "ascending":true // The sort direction is "ascending"
}
Available values
  • ascending
    • true
    • false
  • key
    • SegmentId
    • DocumentId
    • BeeSegmentId
    • Label
    • Score
    • Text
    • LastModification
    • Bookmark
    • Status
    • LastEditor

 

 

Sort by Segment Id

The doc

Code Block
{
 "key":"SegmentId", // Sort by segment id
 "ascending":true // The sort direction is "ascending"
}

 

Sort by Document Id

The doc

Code Block
{
 "key":"DocumentId", // Sort by document id
 "ascending":true // The sort direction is "ascending"
}

 

Sort

...

by BeeSegmentId

The doc

Code Block
{
 "key":"DocumentIdBeeSegmentId", // TypeSort ofby sortBeeSegmentId
 "ascending":true // The sort direction is "ascending"
}

 

Sort by

...

Label

The doc

Code Block
{
 "key":"DocumentIdLabel", // TypeSort ofby sortlabel
 "ascending":true // The sort direction is "ascending"
}

 

Sort by

...

Score

The doc

Code Block
{
 "key":"DocumentIdScore", // TypeSort ofby sortscore
 "ascending":true // The sort direction is "ascending"
}

 

Sort by

...

Text

The doc

Code Block
{
 "key":"DocumentIdText", // TypeSort ofby sorttext
 "ascending":true // The sort direction is "ascending"
}

 

Sort

...

by LastModification

The doc

Code Block
{
 "key":"DocumentIdLastModification", // TypeLast of sortModification
 "ascending":false // The sort direction is "descending"
}

 

Sort

...

by Bookmark

The doc

Code Block
{
 "key":"DocumentIdBookmark", // TypeSort ofby sortbookmark
 "ascending":true // The sort direction is "ascending"
}

...



Sort by Status

 The doc

 

 

 

 

keyDescription
0DocumentId
1SegmentId
2BeeSegmentId
3Label
4Score
5Text
6LastModification
7Bookmark
8Status
9LastEditor

 

 

...

Code Block
{
 "key":"Status", // Sort by status
 "ascending":true // The sort direction is "ascending"
}


Sort by LastEditor

The doc

Code Block
{
 "key":"LastEditor", // Sort by LastEditor
 "ascending":true // The sort direction is "ascending"
}