Property | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
bodyContainsMagicBlank |
Indicates if the HTML body of the contract contains one or more 'magic blank' placeholder strings. |
||||||||||||||
contractStatus |
The current status of the contract.
|
||||||||||||||
expirationDate |
The date on which this contract expires. |
||||||||||||||
id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
isHidden |
Whether the contract has been marked 'hidden'. |
||||||||||||||
links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
||||||||||||||
name |
The name for this contract. |
||||||||||||||
publicId |
The public identifier for this contract (may be used in the portal website). |
||||||||||||||
type |
The type of resource represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"properties": {
"bodyContainsMagicBlank": {
"description": "Indicates if the HTML body of the contract contains one or more\n'magic blank' placeholder strings.",
"type": "boolean"
},
"contractStatus": {
"$ref": "#/components/schemas/Contract/properties/contractStatus"
},
"expirationDate": {
"description": "The date on which this contract expires.",
"format": "date-time",
"type": "string"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"isHidden": {
"description": "Whether the contract has been marked 'hidden'.",
"type": "boolean"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"name": {
"description": "The name for this contract.",
"type": "string"
},
"publicId": {
"description": "The public identifier for this contract (may be used in the portal\nwebsite).",
"pattern": "^[a-fA-F0-9]{32}$",
"type": "string"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/Type"
},
{
"enum": [
"contract"
]
}
]
}
},
"title": "Contract",
"type": "object"
}