TEtermscout

General overview and metadata for a given contract

get/contracts/{contract-id}/overview

Request

Path parameters

contract-idstring required

Response

200 response

party_astring

One of the parties in the contract

party_bstring

The other party in the contract

template_idnumber

ID of the template this contract belongs to

template_namestring

Name of the template this contract belongs to, e.g., 'IT' or 'Business Intelligence Software'

parent_template_idnumber

ID of the parent template

is_publicnumber

Visibility of contract. 1 if public, 0 if private

contract_position_idnumber

Contract position id of contract

rating_displaystring

User friendly display of contract rating

product_suite_idnumber

ID of product suite, or company, that contract belongs to

product_suite_namestring

Name of product suite, or company, that contract belongs to

product_suite_urlstring

DEPRECATED

max_scorenumber double

Max score

overall_scorenumber double

Numeric representation of the overall score

rating_percentilenumber double

Number value of contract rating. On a scale of 0-10, 0 is Vendor Favorable, 5 is Balanced and 10 is Customer Favorable

ratingstring

Display friendly rating of contract. Will be one of Customer Favorable, Vendor Favorable or Balanced

raw_ratingstring

Raw rating number of contract

primary_agreementstring

Primary agreement name for the contract

primary_agreement_urlstring uri

Source URL for the contract, where it originated from online

last_updatedstring datetime

Date and time contract was last reviewed

overall_claritystring

Clarity of given contract

contract_positionstring

Position of contract

logo_urlstring uri

Location of image for contract or product suite

badge_urlstring uri

Location of badge

legal_entitystring

Name of legal entity the contract belongs to

secondary_categoriesstring[]

Secondary categories of contract

primary_agreement_defined_termstring

Primary agreement defined term, or short name of primary agreement

notes_to_customerstring

Notes to customer

primary_category_idnumber

Category id of contract

categorystring

Display friendly category name

category_urlstring

DEPRECATED

Changes

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