GET api/search/{searchId}/status Authentication required

Use this method to get a search's status: Open: the filters can still be modified Previewed: the preview was generated but no records were extracted. The filters can still be modified Extracted: records were exported Closed: the search is closed, meaning it cannot be modified, previewed, and records can no longer be extracted

Request

URI Parameters

NameDescriptionTypeAdditional information
searchId

Id of the search

 integer

Required

Response

Returns the search's status

Output : object (See Model)

Ouput Sample

  • application/json, text/json :
    • { "searchId": 1, "status": "Extracted", "additionnalInformations": [ "187 records were extracted" ], "canBeModified": false, "canBePreviewed": false, "canBeExtracted": false }
  • application/xml, text/xml :
    • <SearchStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <AdditionnalInformations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>187 records were extracted</d2p1:string> </AdditionnalInformations> <CanBeExtracted>false</CanBeExtracted> <CanBeModified>false</CanBeModified> <CanBePreviewed>false</CanBePreviewed> <SearchId>1</SearchId> <Status>Extracted</Status> </SearchStatus>