Modify simple document

POST

api/v2/docs/p/:project_id/:action

Modify simple document

Path Parameters

• project_id string required
  Example: a1ab1abc-a123-123a-123a-abcd12ab1a12
• action string required

  Operation to do on the ducument. Allowed values: create, update, upserte, delete, undelete.

  Example: update

Query Parameters

• annotate string

  Talkwalker API recalculates set field based on the updated content.

  Example: sentiment
• return_entry string

  Specifies if the modified document should be returned. Allowed values: hide or show. Default value: hide

  Example: hide
• proc_tokens_calc string

  Specifies when and which tokens are generated. Allowed values: all_if_new, all_always_if_possible. default value: all_if_new

  Example: all_if_new
• proc_lang_autodetect string

  Specifies when the language is automatically detected Allowed values: only_if_new, always_if_new_content. Fefault value: only_if_new

  Example: only_if_new
• proc_content_ellipsis string

  Special behavior for ellipsis in string fields. Allowed values: no_special_handling, ignore_if_start_same. Default value: ignore_if_start_same

  Example: ignore_if_start_same
• proc_lang_fallback string

  default language code: en

  Example: en
• proc_annotate_language string

  Language annotation. Allowed values: annotate_if_not_set, use_default. Default value: annotate_if_not_set.

  Example: annotate_if_not_set
• proc_annotate_sentiment string

  Sentiment annotation. Allowed values: annotate_if_not_set, use_default. Default value: annotate_if_not_set.

  Example: annotate_if_not_set

application/json

Request Body

• object

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• object

{}

{
  "request": "POST /api/v2/docs/p/a1ab1abc-a123-123a-123a-abcd12ab1a12/update?annotate=sentiment&return_entry=hide&proc_tokens_calc=all_if_new&proc_lang_autodetect=only_if_new&proc_content_ellipsis=ignore_if_start_same&proc_lang_fallback=en&proc_annotate_language=annotate_if_not_set&proc_annotate_sentiment=annotate_if_not_set&access_token=abcd_1234_abcd",
  "request_id": "#r8vvcgx8oa06#",
  "result_searchdoc": [
    {
      "action": "update",
      "status_code": "0",
      "status_message": "OK",
      "url": "https://test-cpl.tt"
    }
  ],
  "status_code": "0",
  "status_message": "OK"
}

Loading...