Skip to main content

Web Service Method: Update and Return Indexed Documents

Abstract

Web Service Method: Update and Return Indexed Documents

Description

This API call updates indexed documents and returns the updated documents

URL: /api/content/update/documents

Request

Supported Method

GET

Content-Type

application/x-www-form-urlencoded

Request Parameters

Parameter

Type

Required

Description

searchSpaceId

String

false

SearchSpace Identifier

ids

Array of String

true

Documents to synchronize

Response

Content-Type: application/json

Response Attributes

Attribute

Type

Required

Comment

dynUriAndLabels

Map of String

false

Field values

id

String

false

Identifier

Note

The return to this request will display these errors in the following specific cases:

  • If the Search Space ID is wrong, you will receive a 404 'Bad Request' message, with specific information in a JSON message as to the value that was not found.

  • If the credentials were mistyped or wrong: a 403 Forbidden, and a JSON message 'Access denied' will be returned.

  • If you didn't specify a Search Space ID: the return will be made for the default Search Space.

    • If the default Search Space is private and you are not authenticated, you will also receive a 403 Forbidden in a JSON message.

Example Response
{
  "id" : "some id",
  "dynUriAndLabels" : { }
}