Skip to main content

Web Service Method: Update or Create an Indexed Document

Abstract

Web Service Method: Update or Create an Indexed Document

Description

This API updates an existing entry in the search index with the provided properties, or creates a new entry if the requested entry does not exist.

Note

All behavior is identical to the createIndexedDocument API method with /api/content/create

In order to find appropriate content with search services, you should extract and annotate uploaded content with concepts from the thesaurus in advance, during content creation, and update with /api/content/create and /api/content/update APIs.

URL: /api/content/update

Request

Supported Method

POST

Content-Type

application/x-www-form-urlencoded

Content Update Request Object Attributes

Attribute

Type

Required

Comment

author

String

true

Content author

context

String

false

Content context

date

Date

false

Content creation

facets

Map of String

false

Content map of manually created facets (SearchField, facets)

identifier

URL

true

Content URL/ID

language

String

false

Content language

searchSpaceId

String

true

SearchSpace identifier

synchronize

boolean

false

Synchronize automatically. Set to false for bulk content push. Refresh manually.

text

String

false

Content text

By default, the maximum number of characters is 12048. This value can be changed in The poolparty.properties File.The poolparty.properties File

title

String

true

Content title

By default, the maximum number of characters is 1250. This can be changed in The poolparty.properties File.The poolparty.properties File

useExtraction

boolean

false

Use extraction for tagging

website

URL

false

Content from external URL (web crawling)

Note

If you do not specify a searchSpaceId, the return will list results for the default Search Space.

Example Request
{
  "date" : "2017-01-27",
  "identifier" : "https://semantic-web.com/",
  "searchSpaceId" : "some searchSpaceId",
  "website" : "https://semantic-web.com/",
  "author" : "some author",
  "context" : "some context",
  "useExtraction" : false,
  "language" : "en",
  "text" : "some text",
  "title" : "All about Cocktails",
  "facets" : { },
  "synchronize" : true
}

Response

Content Type

text/plain

Status: 200 - OK