LElexpredict
project
v1

POST /api/v1/project/projects/{id}/update_document_fields/

Changed on

Bulk update project documents field, similar to /fields/ API in document app

Params:
    document_ids: list[int]
    all: any value - update all documents if any value
    no_document_ids: list[int] - exclude those docs from action (if "all" is set)
    fields_data: - dict {field_code: [values]}
    on_existing_value: "replace_all" | "add_new" (for multi-choice fields)
Returns:
    task_id

Request

Path parameters

idstring required

A unique integer value identifying this project.

Request body

allboolean
document_idsinteger[]
no_document_idsinteger[]
fields_dataobject required
on_existing_valuestring

Example request

{
  "all": true,
  "document_ids": [
    0,
    0
  ],
  "fields_data": "{}",
  "no_document_ids": [
    6,
    6
  ],
  "on_existing_value": "on_existing_value"
}

Response

task_idstring uuid required
inactive_document_idsinteger[] required
inactive_document_namesstring[] required

Example response

{
  "task_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "inactive_document_names": [
    "inactive_document_names",
    "inactive_document_names"
  ],
  "inactive_document_ids": [
    0,
    0
  ]
}

Changes

  • 3429f921b4cbRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 63116f2e9e3eRevision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)