Contracts

Create Contract

Documentation for Item Types

  1. Text

  • Description: Handles plain textual data.
  • Input Example: "Hello, World!"
  • Output Example: "Hello, World!"
  1. RichText

  • Description: Manages text with rich text formatting elements.
  • Input Example: "Hello, World!"
  • Output Example: "In a visual medium: Hello, World!"
  1. DateInterval (DATEDELTA)

  • Description: Represents an interval of dates.Intervals allowed: "month", "week", "day", "year" and "hour".
  • Input Example: {"size": 10, "interval": "day"}
  • Output Example: {"size": 10, "interval": "day"}
  1. Date

  • Description: Manages a single date value. input as %Y-%m-%d format, output as ISO 8601 format
  • Input Example: "2023-01-01"
  • Output Example: "'2023-10-03T14:12:07.797100'
  1. SingleSelect

  • Description: Handles the selection of a single option from a set of choices.Please take a look at args for 'item' of type SingleSelect,\nInput is the key of the option to be selected,\noutput is the value of the option selected.
  • Input Example: 2
  • Output Example: "banana"
  1. Binary

  • Description: Manages binary values, typically representing true or false.
  • Input Example: True
  • Output Example: True
  1. MultiSelect

  • Description: Handles the selection of multiple options from a list.Please take a look at args for 'item' of type MultiSelect.Input is the list of keys of the options to be selected,\noutput is the list of values of the options selected.
  • Input Example: [0, 2]
  • Output Example: ["apple", "cherry"]
  1. Phone

  • Description: Processes phone number data.
  • Input Example: "+1-123-456-7890"
  • Output Example: "+1-123-456-7890"
  1. Email

  • Description: Manages email address information.
  • Input Example: "user@example.com"
  • Output Example: "user@example.com"
  1. User

  • Description: Validates and saves expent user-related data.
  • Input Example: [76]
  • Output Example: { "type": "USER", "id": "76", "name": "Barry Allen", "email": "hsalf@speed.com", },
  1. Team

  • Description: Validates and saves expent team-related data.
  • Input Example: [33]
  • Output Example: "{"type": "TEAM", "id": "32", "name": "Avengers", "email": None}"
  1. Number

  • Description: Manages numerical values.
  • Input Example: 42
  • Output Example: 42
  1. File

  • Description: Processes file data.
  • Input Example: {"filename": "document.txt", "filetype": "txt", "url": "http://example.com/document.txt"}
  • Output Example: "document.txt (txt) - [Link](http://example.com/document.txt)"
  1. Url

  • Description: Manages web URLs.
  • Input Example: "http://example.com"
  • Output Example: "http://example.com"
  1. Currency

  • Description: Processes currency data.
  • Input Example: {"amount": 100, "currency": "USD"}
  • Output Example: "100 USD"

Note: The exact nature of input and output may vary based on specific system requirements and configurations.

post/v2/contract

Headers

authorizationstring required

The authorization token can be retrieved by calling the OAuth authentication API. The value for this header parameter follows the format "Bearer    access_token" (excluding the quotes). For example: <br /> Bearer MZA1YJMYZDKTZTFMMI0ZYZG1LTLMMDGTYTG4NJG2YZC3NJGY

The authorization token can be retrieved by calling the OAuth authentication API. The value for this header parameter follows the format "Bearer    access_token" (excluding the quotes). For example: <br /> Bearer MZA1YJMYZDKTZTFMMI0ZYZG1LTLMMDGTYTG4NJG2YZC3NJGY

Request body

document_subtypestring required
entitystring required
filesobject[]
ownersstring[]
namestring required
start_datestring
end_datestring
statusinteger
parseboolean
renewal_datestring
renewal_statusinteger
project_idstring
discrepenciesinteger
missing_clauses_countinteger
partial_compliance_countinteger
is_contractboolean required
risk_severityobject

Response

Successful Response

idstring required
filesobject[] required
ownersobject[] required
namestring
start_datestring date-time
end_datestring date-time
statusobject required
renewal_datestring date-time
renewal_statusobject
project_idstring
source_project_idstring
discrepenciesinteger
missing_clauses_countinteger
partial_compliance_countinteger
is_contractboolean required
risk_severityobject
role'READ' | 'WRITE'

An enumeration.

updated_atstring date-time required

Changes

No recorded changes to this endpoint across all 1 revision of this API.