Solr Query Parameters

Introduction

Different calls on the platform are designed to make use of query parameters like Solr has. Only a small number of those do actually implement full Solr syntax. For full listing on these calls see Full Solr calls section of this page.

Majority of all other query (listing) calls on the platform support somewhat slimmed-down version of Solr parameters using sort, limit, query, filter query, …​

Table

Field Example Description

*

Query string. Searches in all fields for a match.

start

0

Used for paging. Start returning results within the resultset from this position. Defaults to 0. The total amount of results is returned as the X-Pagination-Total-Results header of the response. See Solr Common Query Parameters.

rows

10

Used for paging. Amount of results to returns, starting at 'start' parameter. Defaults to 10. See Solr Common Query Parameters - rows.

fq

funnel:ClipAnnotation

A filter query. The syntax is field:value . Multiple filter queries can be specified to enforce multiple restrictions. See (Solr Common Query Parameters - fq).

sort

sort ASC

Sort the results on a field. See (Solr Common Query Parameters - sort).

fl

id,start,description

A list of fields which should be returned. Defaults to all fields. See Solr Common Query Parameters - fl.

Full Solr calls

The calls beneath are implemented in full compliance with solr query parameters.

Annotation

  • search

GET /an

Query for annotations across productions.

Details
Description

Returns the search result. You can add .srt, .webvtt, .json, .stl or .ebuttd as extension to receive a different serialization format. This call makes use of Solr query parameters. For more info on those, checkout Solr Query parameters .

Parameters
Query Parameters
Name Description Required Type

isCompressed

Compressed result or not. If turned on, clip properties will be moved to a separate group.

✘

Boolean
Return Type

AnnotationSolrDocumentList

Field Name Required Type Description Format

elapsedTime

✘

Long

int64

facetDates

✘

List of FacetField

facetFields

✘

List of IFacetField

facetPivot

✘

Map of object

facetQuery

✘

Map of integer

int32

facetRanges

✘

List of object

fieldStatsInfo

✘

Map of IFieldStatsInfo

groupResponse

✘

GroupResponse

highlighting

✘

Map of map

items

✘

List of Component

mediaObjectProperties

✘

Map of map

numFound

✘

Long

int64

responseHeader

✘

Map of object

results

✘

List of SolrDocument

start

✘

Long

int64

termsResponse

✘

TermsResponse
Content Type

  • application/json

Responses
Table 1. http response codes
Code Description Datatype

200

The search request was successful.

AnnotationSolrDocumentList

403

The user needs SUPPORT rights.

ForbiddenError

404

The production was not found.

NotFoundError

  • searchMediaObject

GET /production/{prId}/mo/{moId}/an/search

Search for annotations within a MediaObject. Warning: This call has been marked as deprecated!

Details
Description

Returns the search result. You can add .srt, .webvtt, .json, .stl or .ebuttd as extension to receive a different serialization format. This call makes use of Solr query parameters. For more info on those, checkout Solr Query parameters .

Parameters
Path Parameters
Name Description Required Type

prId

ID of the production.

✔

Long

moId

ID of the media object.

✔

Long
Query Parameters
Name Description Required Type

isCompressed

Compressed result or not.

✘

Boolean
Return Type

AnnotationSolrDocumentList

Field Name Required Type Description Format

elapsedTime

✘

Long

int64

facetDates

✘

List of FacetField

facetFields

✘

List of IFacetField

facetPivot

✘

Map of object

facetQuery

✘

Map of integer

int32

facetRanges

✘

List of object

fieldStatsInfo

✘

Map of IFieldStatsInfo

groupResponse

✘

GroupResponse

highlighting

✘

Map of map

items

✘

List of Component

mediaObjectProperties

✘

Map of map

numFound

✘

Long

int64

responseHeader

✘

Map of object

results

✘

List of SolrDocument

start

✘

Long

int64

termsResponse

✘

TermsResponse
Content Type

  • application/json

Responses
Table 2. http response codes
Code Description Datatype

200

The request was successful.

AnnotationSolrDocumentList

403

The user needs PRODUCTION_VIEW rights.

ForbiddenError

404

The production or media object was not found.

NotFoundError

  • listMediaObject

GET /production/{prId}/mo/{moId}/an

List all available subclips on a clip.

Details
Description

Returns the search result. You can add .srt, .webvtt, .json, .stl or .ebuttd as extension to receive a different serialization format. This call makes use of Solr query parameters. For more info on those, checkout Solr Query parameters .

Parameters
Path Parameters
Name Description Required Type

prId

ID of the production.

✔

Long

moId

ID of the mediaObject.

✔

Long
Query Parameters
Name Description Required Type

isCompressed

Compressed result or not.

✘

Boolean
Return Type

AnnotationSolrDocumentList

Field Name Required Type Description Format

elapsedTime

✘

Long

int64

facetDates

✘

List of FacetField

facetFields

✘

List of IFacetField

facetPivot

✘

Map of object

facetQuery

✘

Map of integer

int32

facetRanges

✘

List of object

fieldStatsInfo

✘

Map of IFieldStatsInfo

groupResponse

✘

GroupResponse

highlighting

✘

Map of map

items

✘

List of Component

mediaObjectProperties

✘

Map of map

numFound

✘

Long

int64

responseHeader

✘

Map of object

results

✘

List of SolrDocument

start

✘

Long

int64

termsResponse

✘

TermsResponse
Content Type

  • application/json

Responses
Table 3. http response codes
Code Description Datatype

200

The request was successful.

AnnotationSolrDocumentList

403

The user needs PRODUCTION_VIEW rights.

ForbiddenError

404

The production or media object was not found.

NotFoundError

  • searchProduction

GET /production/{prId}/an/search

Query for production annotations.

Details
Description

Returns the search result. You can add .srt, .webvtt, .json, .stl or .ebuttd as extension to receive a different serialization format. This call makes use of Solr query parameters. For more info on those, checkout Solr Query parameters .

Parameters
Path Parameters
Name Description Required Type

prId

ID of the production.

✔

Long
Query Parameters
Name Description Required Type

isCompressed

Compressed result or not. If turned on, clip properties will be moved to a separate group.

✘

Boolean
Return Type

AnnotationSolrDocumentList

Field Name Required Type Description Format

elapsedTime

✘

Long

int64

facetDates

✘

List of FacetField

facetFields

✘

List of IFacetField

facetPivot

✘

Map of object

facetQuery

✘

Map of integer

int32

facetRanges

✘

List of object

fieldStatsInfo

✘

Map of IFieldStatsInfo

groupResponse

✘

GroupResponse

highlighting

✘

Map of map

items

✘

List of Component

mediaObjectProperties

✘

Map of map

numFound

✘

Long

int64

responseHeader

✘

Map of object

results

✘

List of SolrDocument

start

✘

Long

int64

termsResponse

✘

TermsResponse
Content Type

  • application/json

Responses
Table 4. http response codes
Code Description Datatype

200

The search request was successful.

AnnotationSolrDocumentList

403

The user needs PRODUCTION_VIEW rights.

ForbiddenError

404

The production was not found.

NotFoundError

  • listProduction

GET /production/{prId}/an

Query for production annotations.

Details
Description

Returns the search result. You can add .srt, .webvtt, .json, .stl or .ebuttd as extension to receive a different serialization format. This call makes use of Solr query parameters. For more info on those, checkout Solr Query parameters .

Parameters
Path Parameters
Name Description Required Type

prId

ID of the production.

✔

Long
Query Parameters
Name Description Required Type

isCompressed

Compressed result or not. If turned on, clip properties will be moved to a separate group.

✘

Boolean
Return Type

AnnotationSolrDocumentList

Field Name Required Type Description Format

elapsedTime

✘

Long

int64

facetDates

✘

List of FacetField

facetFields

✘

List of IFacetField

facetPivot

✘

Map of object

facetQuery

✘

Map of integer

int32

facetRanges

✘

List of object

fieldStatsInfo

✘

Map of IFieldStatsInfo

groupResponse

✘

GroupResponse

highlighting

✘

Map of map

items

✘

List of Component

mediaObjectProperties

✘

Map of map

numFound

✘

Long

int64

responseHeader

✘

Map of object

results

✘

List of SolrDocument

start

✘

Long

int64

termsResponse

✘

TermsResponse
Content Type

  • application/json

Responses
Table 5. http response codes
Code Description Datatype

200

The search request was successful.

AnnotationSolrDocumentList

403

The user needs PRODUCTION_VIEW rights.

ForbiddenError

404

The production was not found.

NotFoundError

Activity

  • search

GET /production/{prId}/activity

Search activities.

Details
Description

Returns the search result. This call makes use of Solr query parameters. For more info on those, checkout Solr Query parameters .

Parameters
Path Parameters
Name Description Required Type

prId

ID of the production.

✔

Long
Query Parameters
Name Description Required Type

includeDebugTraces

Include debug traces in the result or not.

✘

Boolean
Return Type

ActivitySolrDocumentList

Field Name Required Type Description Format

elapsedTime

✘

Long

int64

facetDates

✘

List of FacetField

facetFields

✘

List of IFacetField

facetPivot

✘

Map of object

facetQuery

✘

Map of integer

int32

facetRanges

✘

List of object

fieldStatsInfo

✘

Map of IFieldStatsInfo

groupResponse

✘

GroupResponse

highlighting

✘

Map of map

items

✘

List of Component

mediaObjectProperties

✘

Map of map

numFound

✘

Long

int64

responseHeader

✘

Map of object

results

✘

List of SolrDocument

start

✘

Long

int64

termsResponse

✘

TermsResponse
Content Type

  • application/json

Responses
Table 6. http response codes
Code Description Datatype

200

The search request was successful.

ActivitySolrDocumentList

403

The user needs PRODUCTION_VIEW rights.

ForbiddenError

404

The production was not found.

NotFoundError

  • searchGlobal

GET /activity

Query for searching global activities.

Details
Description

Returns the search result. This call makes use of Solr query parameters. For more info on those, checkout Solr Query parameters .

Parameters
Query Parameters
Name Description Required Type

includeDebugTraces

Include debug traces in the result or not.

✘

Boolean
Return Type

ActivitySolrDocumentList

Field Name Required Type Description Format

elapsedTime

✘

Long

int64

facetDates

✘

List of FacetField

facetFields

✘

List of IFacetField

facetPivot

✘

Map of object

facetQuery

✘

Map of integer

int32

facetRanges

✘

List of object

fieldStatsInfo

✘

Map of IFieldStatsInfo

groupResponse

✘

GroupResponse

highlighting

✘

Map of map

items

✘

List of Component

mediaObjectProperties

✘

Map of map

numFound

✘

Long

int64

responseHeader

✘

Map of object

results

✘

List of SolrDocument

start

✘

Long

int64

termsResponse

✘

TermsResponse
Content Type

  • application/json

Responses
Table 7. http response codes
Code Description Datatype

200

The search request was successful.

ActivitySolrDocumentList

403

The user needs SUPPORT rights.

ForbiddenError

Collections

  • search

GET /production/{prId}/eo/search

Search for collections.

Details
Description

Returns the search result. This call makes use of Solr query parameters. For more info on those, checkout Solr Query parameters .

Parameters
Path Parameters
Name Description Required Type

prId

ID of the production.

✔

Long
Return Type

String

Content Type

  • application/json

Responses
Table 8. http response codes
Code Description Datatype

200

The search request was successful.

String

403

The user needs PRODUCTION_VIEW rights.

ForbiddenError

404

The production was not found.

NotFoundError

Administration

  • searchUsers

GET /admin/user

Query for searching users.

Details
Description

Returns the search result. This call makes use of Solr query parameters. For more info on those, checkout Solr Query parameters.

Parameters

✘

Return Type

DocumentList

Field Name Required Type Description Format

elapsedTime

✘

Long

int64

facetDates

✘

List of FacetField

facetFields

✘

List of IFacetField

facetPivot

✘

Map of object

facetQuery

✘

Map of integer

int32

facetRanges

✘

List of object

fieldStatsInfo

✘

Map of IFieldStatsInfo

groupResponse

✘

GroupResponse

highlighting

✘

Map of map

items

✘

List of Component

mediaObjectProperties

✘

Map of map

numFound

✘

Long

int64

responseHeader

✘

Map of object

results

✘

List of SolrDocument

start

✘

Long

int64

termsResponse

✘

TermsResponse
Content Type

  • application/json

Responses
Table 9. http response codes
Code Description Datatype

0

default response

DocumentList

  • searchSubscriptions

GET /admin/subscription

Query for searching users.

Details
Description

Returns the search result. This call makes use of Solr query parameters. For more info on those, checkout Solr Query parameters .

Parameters

✘

Return Type

DocumentList

Field Name Required Type Description Format

elapsedTime

✘

Long

int64

facetDates

✘

List of FacetField

facetFields

✘

List of IFacetField

facetPivot

✘

Map of object

facetQuery

✘

Map of integer

int32

facetRanges

✘

List of object

fieldStatsInfo

✘

Map of IFieldStatsInfo

groupResponse

✘

GroupResponse

highlighting

✘

Map of map

items

✘

List of Component

mediaObjectProperties

✘

Map of map

numFound

✘

Long

int64

responseHeader

✘

Map of object

results

✘

List of SolrDocument

start

✘

Long

int64

termsResponse

✘

TermsResponse
Content Type

  • application/json

Responses
Table 10. http response codes
Code Description Datatype

0

default response

DocumentList

  • searchPerformanceReports

GET /admin/performance/search

Query for searching users.

Details
Description

Returns the search result. This call makes use of Solr query parameters. For more info on those, checkout Solr Query parameters .

Parameters

✘

Return Type

DocumentList

Field Name Required Type Description Format

elapsedTime

✘

Long

int64

facetDates

✘

List of FacetField

facetFields

✘

List of IFacetField

facetPivot

✘

Map of object

facetQuery

✘

Map of integer

int32

facetRanges

✘

List of object

fieldStatsInfo

✘

Map of IFieldStatsInfo

groupResponse

✘

GroupResponse

highlighting

✘

Map of map

items

✘

List of Component

mediaObjectProperties

✘

Map of map

numFound

✘

Long

int64

responseHeader

✘

Map of object

results

✘

List of SolrDocument

start

✘

Long

int64

termsResponse

✘

TermsResponse
Content Type

  • application/json

Responses
Table 11. http response codes
Code Description Datatype

0

default response

DocumentList

MediaObject

  • searchMediaObjects

GET /production/{prId}/mo/search

Search media objects.

Details
Description

Returns the search result. This call makes use of Solr query parameters. For more info on those, checkout Solr Query parameters .

Parameters
Path Parameters
Name Description Required Type

prId

ID of the production.

✔

Long
Return Type

AnnotationSolrDocumentList

Field Name Required Type Description Format

elapsedTime

✘

Long

int64

facetDates

✘

List of FacetField

facetFields

✘

List of IFacetField

facetPivot

✘

Map of object

facetQuery

✘

Map of integer

int32

facetRanges

✘

List of object

fieldStatsInfo

✘

Map of IFieldStatsInfo

groupResponse

✘

GroupResponse

highlighting

✘

Map of map

items

✘

List of Component

mediaObjectProperties

✘

Map of map

numFound

✘

Long

int64

responseHeader

✘

Map of object

results

✘

List of SolrDocument

start

✘

Long

int64

termsResponse

✘

TermsResponse
Content Type

  • application/json

Responses
Table 12. http response codes
Code Description Datatype

201

The search request was successful.

AnnotationSolrDocumentList

403

The user needs PRODUCTION_VIEW rights.

ForbiddenError

404

The production was not found.

NotFoundError

Flow

searchDebugTrace

GET /flow/debug/search

Search for debug traces.

Details
Description

Returns the search result. This call makes use of Solr query parameters. For more info on those, checkout Solr Query parameters .

Parameters

✘

Return Type

DocumentList

Field Name Required Type Description Format

elapsedTime

✘

Long

int64

facetDates

✘

List of FacetField

facetFields

✘

List of IFacetField

facetPivot

✘

Map of object

facetQuery

✘

Map of integer

int32

facetRanges

✘

List of object

fieldStatsInfo

✘

Map of IFieldStatsInfo

groupResponse

✘

GroupResponse

highlighting

✘

Map of map

items

✘

List of Component

mediaObjectProperties

✘

Map of map

numFound

✘

Long

int64

responseHeader

✘

Map of object

results

✘

List of SolrDocument

start

✘

Long

int64

termsResponse

✘

TermsResponse
Content Type

  • application/json

Responses
Table 13. http response codes
Code Description Datatype

200

The search request was successful.

DocumentList

403

The user needs DEVOPS rights.

ForbiddenError

TranscriptAnnotation

  • searchTranscriptAnnotations

GET /production/{prId}/mo/{moId}/tsa/search

Search for transcript annotations within a media object. Warning: This call has been marked as deprecated!

Details
Description

Returns the search result. This call makes use of Solr query parameters. For more info on those, checkout Solr Query parameters .

Parameters
Path Parameters
Name Description Required Type

prId

ID of the production.

✔

Long

moId

ID of the media object.

✔

Long
Return Type

AnnotationSolrDocumentList

Field Name Required Type Description Format

elapsedTime

✘

Long

int64

facetDates

✘

List of FacetField

facetFields

✘

List of IFacetField

facetPivot

✘

Map of object

facetQuery

✘

Map of integer

int32

facetRanges

✘

List of object

fieldStatsInfo

✘

Map of IFieldStatsInfo

groupResponse

✘

GroupResponse

highlighting

✘

Map of map

items

✘

List of Component

mediaObjectProperties

✘

Map of map

numFound

✘

Long

int64

responseHeader

✘

Map of object

results

✘

List of SolrDocument

start

✘

Long

int64

termsResponse

✘

TermsResponse
Content Type

  • application/json

Responses
Table 14. http response codes
Code Description Datatype

200

The search request was successful.

AnnotationSolrDocumentList

403

The user needs PRODUCTION_VIEW rights.

ForbiddenError

404

The production or media object was not found.

NotFoundError

  • searchAllTranscriptionAnnotation

GET /production/{prId}/tsa/search

Search for transcript annotations.

Details
Description

Returns the search result. This call makes use of Solr query parameters. For more info on those, checkout Solr Query parameters .

Parameters
Path Parameters
Name Description Required Type

prId

ID of the production.

✔

Long
Return Type

AnnotationSolrDocumentList

Field Name Required Type Description Format

elapsedTime

✘

Long

int64

facetDates

✘

List of FacetField

facetFields

✘

List of IFacetField

facetPivot

✘

Map of object

facetQuery

✘

Map of integer

int32

facetRanges

✘

List of object

fieldStatsInfo

✘

Map of IFieldStatsInfo

groupResponse

✘

GroupResponse

highlighting

✘

Map of map

items

✘

List of Component

mediaObjectProperties

✘

Map of map

numFound

✘

Long

int64

responseHeader

✘

Map of object

results

✘

List of SolrDocument

start

✘

Long

int64

termsResponse

✘

TermsResponse
Content Type

  • application/json

Responses
Table 15. http response codes
Code Description Datatype

200

The search request was successful.

AnnotationSolrDocumentList

403

The user needs PRODUCTION_VIEW rights.

ForbiddenError

404

The production or media object was not found.

NotFoundError

Sharing

  • listAnnotationsShare

GET /production/{prId}/share/{id}/an

List all shared annotations within the production.

Details
Description

Returns the search result. This call makes use of Solr query parameters. For more info on those, checkout Solr Query parameters .

Parameters
Path Parameters
Name Description Required Type

prId

ID of the production.

✔

Long

id

ID of the share.

✔

Long
Query Parameters
Name Description Required Type

isCompressed

Compressed result or not.

✘

Boolean
Return Type

AnnotationSolrDocumentList

Field Name Required Type Description Format

elapsedTime

✘

Long

int64

facetDates

✘

List of FacetField

facetFields

✘

List of IFacetField

facetPivot

✘

Map of object

facetQuery

✘

Map of integer

int32

facetRanges

✘

List of object

fieldStatsInfo

✘

Map of IFieldStatsInfo

groupResponse

✘

GroupResponse

highlighting

✘

Map of map

items

✘

List of Component

mediaObjectProperties

✘

Map of map

numFound

✘

Long

int64

responseHeader

✘

Map of object

results

✘

List of SolrDocument

start

✘

Long

int64

termsResponse

✘

TermsResponse
Content Type

  • application/json

Responses
Table 16. http response codes
Code Description Datatype

200

The request was successful.

AnnotationSolrDocumentList

403

The user needs PRODUCTION_VIEW rights.

ForbiddenError

404

The production was not found.

NotFoundError

  • listCreatedAnnotationsShare

GET /production/{prId}/share/{id}/createdannotations

List attached annotations.

Details
Description

Returns the search result. This call makes use of Solr query parameters. For more info on those, checkout Solr Query parameters .

Parameters
Path Parameters
Name Description Required Type

prId

ID of the production.

✔

Long

id

ID of the share.

✔

Long
Query Parameters
Name Description Required Type

isCompressed

Compressed result or not

✘

Boolean
Return Type

AnnotationSolrDocumentList

Field Name Required Type Description Format

elapsedTime

✘

Long

int64

facetDates

✘

List of FacetField

facetFields

✘

List of IFacetField

facetPivot

✘

Map of object

facetQuery

✘

Map of integer

int32

facetRanges

✘

List of object

fieldStatsInfo

✘

Map of IFieldStatsInfo

groupResponse

✘

GroupResponse

highlighting

✘

Map of map

items

✘

List of Component

mediaObjectProperties

✘

Map of map

numFound

✘

Long

int64

responseHeader

✘

Map of object

results

✘

List of SolrDocument

start

✘

Long

int64

termsResponse

✘

TermsResponse
Content Type

  • application/json

Responses
Table 17. http response codes
Code Description Datatype

200

The request was successful.

AnnotationSolrDocumentList

403

The user needs PRODUCTION_VIEW rights.

ForbiddenError

404

The production was not found.

NotFoundError

  • listAttachedAnnotationsShare

GET /production/{prId}/share/{id}/attachedannotations

List attached annotations.

Details
Description

Returns the search result. This call makes use of Solr query parameters. For more info on those, checkout Solr Query parameters .

Parameters
Path Parameters
Name Description Required Type

prId

ID of the production.

✔

Long

id

ID of the share.

✔

Long
Query Parameters
Name Description Required Type

isCompressed

Compressed result or not.

✘

Boolean
Return Type

AnnotationSolrDocumentList

Field Name Required Type Description Format

elapsedTime

✘

Long

int64

facetDates

✘

List of FacetField

facetFields

✘

List of IFacetField

facetPivot

✘

Map of object

facetQuery

✘

Map of integer

int32

facetRanges

✘

List of object

fieldStatsInfo

✘

Map of IFieldStatsInfo

groupResponse

✘

GroupResponse

highlighting

✘

Map of map

items

✘

List of Component

mediaObjectProperties

✘

Map of map

numFound

✘

Long

int64

responseHeader

✘

Map of object

results

✘

List of SolrDocument

start

✘

Long

int64

termsResponse

✘

TermsResponse
Content Type

  • application/json

Responses
Table 18. http response codes
Code Description Datatype

200

The request was successful.

AnnotationSolrDocumentList

403

The user needs PRODUCTION_VIEW rights.

ForbiddenError

404

The production was not found.

NotFoundError

Thesaurus

  • searchTags

GET /production/{prId}/thesaurus/tags

Retrieve a list of tags currently being used in the production. Warning: This call has been marked as deprecated!

Details
Description

Returns the search result. This call makes use of Solr query parameters. For more info on those, checkout Solr Query parameters .

Parameters
Path Parameters
Name Description Required Type

prId

ID of the production.

✔

Long
Query Parameters
Name Description Required Type

prefix

Only return tags which are prefixed by the prefix

✘

String
Return Type

String

Content Type

  • application/json

Responses
Table 19. http response codes
Code Description Datatype

200

The request was successful.

String

403

The user needs PRODUCTION_VIEW rights.

ForbiddenError

404

The production was not found.

NotFoundError

  • listTags

GET /production/{prId}/thesaurus/{id}/tags

List tags in a thesaurus.

Details
Description

Returns the search result. This call makes use of Solr query parameters. For more info on those, checkout Solr Query parameters .

Parameters
Path Parameters
Name Description Required Type

prId

ID of the production.

✔

Long

id

ID of the thesaurus.

✔

String
Query Parameters
Name Description Required Type

model

Limit the scope of the search to the specified model.

✘

String

prefix

Only return tags which are prefixed by the prefix

✘

String
Return Type

String

Content Type

  • application/json

Responses
Table 20. http response codes
Code Description Datatype

200

The request was successful.

String

403

The user needs PRODUCTION_VIEW rights.

ForbiddenError

404

The production was not found.

NotFoundError

  • listEntries

GET /thesaurus/{id}/entry

List entries in a thesaurus.

Details
Description

Returns the search result. This call makes use of Solr query parameters. For more info on those, checkout Solr Query parameters .

Parameters
Path Parameters
Name Description Required Type

id

ID of the production.

✔

Long
Return Type

ThesaurusSolrDocumentList

Field Name Required Type Description Format

elapsedTime

✘

Long

int64

facetDates

✘

List of FacetField

facetFields

✘

List of IFacetField

facetPivot

✘

Map of object

facetQuery

✘

Map of integer

int32

facetRanges

✘

List of object

fieldStatsInfo

✘

Map of IFieldStatsInfo

groupResponse

✘

GroupResponse

highlighting

✘

Map of map

items

✘

List of Component

mediaObjectProperties

✘

Map of map

numFound

✘

Long

int64

responseHeader

✘

Map of object

results

✘

List of SolrDocument

start

✘

Long

int64

termsResponse

✘

TermsResponse
Content Type

  • application/json

Responses
Table 21. http response codes
Code Description Datatype

200

The request was successful.

ThesaurusSolrDocumentList

403

The user needs PRODUCTION_VIEW rights.

ForbiddenError

404

The production was not found.

NotFoundError

  • listProductionEntries

GET /production/{prId}/thesaurus/{id}/entry

List production entries in a thesaurus.

Details
Description

Returns the search result. This call makes use of Solr query parameters. For more info on those, checkout Solr Query parameters .

Parameters
Path Parameters
Name Description Required Type

prId

ID of the production.

✔

Long

id

ID of the thesaurus.

✔

Long
Return Type

ThesaurusSolrDocumentList

Field Name Required Type Description Format

elapsedTime

✘

Long

int64

facetDates

✘

List of FacetField

facetFields

✘

List of IFacetField

facetPivot

✘

Map of object

facetQuery

✘

Map of integer

int32

facetRanges

✘

List of object

fieldStatsInfo

✘

Map of IFieldStatsInfo

groupResponse

✘

GroupResponse

highlighting

✘

Map of map

items

✘

List of Component

mediaObjectProperties

✘

Map of map

numFound

✘

Long

int64

responseHeader

✘

Map of object

results

✘

List of SolrDocument

start

✘

Long

int64

termsResponse

✘

TermsResponse
Content Type

  • application/json

Responses
Table 22. http response codes
Code Description Datatype

200

The request was successful.

ThesaurusSolrDocumentList

403

The user needs PRODUCTION_VIEW rights.

ForbiddenError

404

The production or thesaurus was not found.

NotFoundError