Description |
---|
Creates an export job based on an export format. |
URL: /GraphSearch/api/export/{format}
Content-Type: application/json
Supported Methods |
---|
|
Path Variables
Variable | Description |
---|---|
| Export format Excel | RDF | WORD |
Request Body
SearchRequest
Attribute | Type | Required | Description |
---|---|---|---|
| Integer | false | Number of results |
| Array of Strings | false | Fetch facets of a document. Set to all to fetch all facets. |
| String | false | Request encoding |
| Integer | false | Minimum number of facets |
| String | false | Search locale |
| Integer | false | Maximum number facets |
| String | false | Search using a custom query |
| Array of SearchFacets | false | Returns facets based on the result. Leave empty to fetch all. |
| Array of SearchFilters | false | Search filters |
| String | false | SearchSpace identifier |
| SortInfo | false | Sorting |
| Integer | false | Start of results (pagination) |
Example
{
"searchSpaceId" : "some searchSpaceId",
"facetMinCount" : 21595,
"count" : 10679,
"start" : 936,
"nativeQuery" : "some nativeQuery",
"documentFacets" : [ "some documentFacets", "some documentFacets", "some documentFacets" ],
"searchFilters" : [ {
"boosting" : 0.6780727,
"field" : "some field",
"NULL_BOOSTING" : 0.21173638,
"language" : "fr",
"optional" : true,
"value" : "some value"
} ],
"sort" : {
"field" : "some field",
"direction" : "ASC"
},
"encoding" : "some encoding",
"locale" : "some locale",
"maxFacetCount" : 3975,
"searchFacets" : [ {
"field" : "some field",
"facetMode" : "list"
}, {
"field" : "some field",
"facetMode" : "aggregate"
} ]
}
SearchFacets
Attribute | Type | Required | Comment |
---|---|---|---|
| FacetMode | false | Facet modes: aggregate | list | tree |
| String | false | Facet field |
Example
{
"field" : "some field",
"facetMode" : "tree"
}
SearchFilters
Attribute | Type | Required | Comment |
---|---|---|---|
| Float | false | |
| Float | false | Boost filter |
| String | false | Search field |
| String | false | Filter language |
| Boolean | false | Optional filter |
| String | false | Value for the filter |
Example
{
"boosting" : 0.3566736,
"field" : "some field",
"NULL_BOOSTING" : 0.5067384,
"language" : "en-us",
"optional" : true,
"value" : "some value"
}
SortInfo
Attribute | Type | Required | Comment |
---|---|---|---|
| SortDirection | false | Sorting direction (ASC || DESC) DESC | ASC |
| String | false | Sort field |
Example
{
"field" : "some field",
"direction" : "ASC"
}
Content-Type: application/json
ExportStatus
Attribute | Type | Required | Comment |
---|---|---|---|
| String | false | Export process identifier |
| Integer | false | Progress of the export process |
{
"processId" : "some processId",
"progress" : 8302
}