Web Service Method: Create a Format Based Export Job

Abstract

Description
Creates an export job based on an export format.

Request

URL: /GraphSearch/api/export/{format}

Content-Type: application/json

Supported Methods
`POST`

Path Variables

Variable	Description
`{format}`	Export format Excel \| RDF \| WORD

Request Body

SearchRequest

Attribute	Type	Required	Description
`count`	Integer	false	Number of results
`documentFacets`	Array of Strings	false	Fetch facets of a document. Set to all to fetch all facets.
`encoding`	String	false	Request encoding
`facetMinCount`	Integer	false	Minimum number of facets
`locale`	String	false	Search locale
`maxFacetCount`	Integer	false	Maximum number facets
`nativeQuery`	String	false	Search using a custom query
`searchFacets`	Array of SearchFacets	false	Returns facets based on the result. Leave empty to fetch all.
`searchFilters`	Array of SearchFilters	false	Search filters
`searchSpaceId`	String	false	SearchSpace identifier
`sort`	SortInfo	false	Sorting
`start`	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`	FacetMode	false	Facet modes: aggregate \| list \| tree
`field`	String	false	Facet field

Example

{
  "field" : "some field",
  "facetMode" : "tree"
}

SearchFilters

Attribute	Type	Required	Comment
`NULL_BOOSTING`	Float	false
`boosting`	Float	false	Boost filter
`field`	String	false	Search field
`language`	String	false	Filter language
`optional`	Boolean	false	Optional filter
`value`	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
`direction`	SortDirection	false	Sorting direction (ASC \|\| DESC) DESC \| ASC
`field`	String	false	Sort field

Example

{
  "field" : "some field",
  "direction" : "ASC"
}

Response

Content-Type: application/json

ExportStatus

Attribute	Type	Required	Comment
`processId`	String	false	Export process identifier
`progress`	Integer	false	Progress of the export process

{
  "processId" : "some processId",
  "progress" : 8302
}

In this section: