project

v1

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

Changed on May 24, 2021

Partial Update Project

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/lexpredict/apis/contraxsuite-api/docs/api/v1/project/projects/:id/patch.ts
A function with typed inputs. Its response is checked against the schema.

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
}

Changes

May 24, 20218167164be9cc Revision 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)
- 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)
- 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)
- 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)
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
Dec 11, 20200957c4a7ae3d Revision changes
- warning
  removed the request property (media type: application/json)
- warning
  removed the request property (media type: application/x-www-form-urlencoded)
- warning
  removed the request property (media type: multipart/form-data)
- warning
  removed the request property (media type: application/json)
- warning
  removed the request property (media type: application/x-www-form-urlencoded)
- warning
  removed the request property (media type: multipart/form-data)
- warning
  removed the request property (media type: application/json)
- warning
  removed the request property (media type: application/x-www-form-urlencoded)
- warning
  removed the request property (media type: multipart/form-data)
- warning
  removed the request property (media type: application/json)
- warning
  removed the request property (media type: application/x-www-form-urlencoded)
- warning
  removed the request property (media type: multipart/form-data)
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status

Operation history