v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB
project
v1

Create Document/TextUnit Vectors if needed Update ocr_enable project app var if needed

put/api/v1/project/projects/{id}/

Path parameters

idstring required

A unique integer value identifying this project.

Request body

pkinteger
namestring required
descriptionstring nullable
statusinteger
send_email_notificationboolean
ownersinteger[]
reviewersinteger[]
super_reviewersinteger[]
junior_reviewersinteger[]
typestring
hide_clause_reviewboolean
term_tagsinteger[]
companytype_tagsinteger[]
document_transformerinteger nullable
text_unit_transformerinteger nullable

Example request

{
  "text_unit_transformer": 2,
  "junior_reviewers": [
    2,
    2
  ],
  "send_email_notification": true,
  "description": "description",
  "owners": [
    1,
    1
  ],
  "type": "type",
  "companytype_tags": [
    9,
    9
  ],
  "reviewers": [
    5,
    5
  ],
  "document_transformer": 3,
  "name": "name",
  "super_reviewers": [
    5,
    5
  ],
  "hide_clause_review": true,
  "pk": 0,
  "term_tags": [
    7,
    7
  ],
  "status": 6
}

Response

pkinteger
namestring required
descriptionstring nullable
statusinteger
send_email_notificationboolean
ownersinteger[]
reviewersinteger[]
super_reviewersinteger[]
junior_reviewersinteger[]
typestring
hide_clause_reviewboolean
term_tagsinteger[]
companytype_tagsinteger[]
document_transformerinteger nullable
text_unit_transformerinteger nullable

Example response

{
  "text_unit_transformer": 2,
  "junior_reviewers": [
    2,
    2
  ],
  "send_email_notification": true,
  "description": "description",
  "owners": [
    1,
    1
  ],
  "type": "type",
  "companytype_tags": [
    9,
    9
  ],
  "reviewers": [
    5,
    5
  ],
  "document_transformer": 3,
  "name": "name",
  "super_reviewers": [
    5,
    5
  ],
  "hide_clause_review": true,
  "pk": 0,
  "term_tags": [
    7,
    7
  ],
  "status": 6
}