A collection (or list) of resources.
Property | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
items |
A collection of resources returned in the current result set.
|
||||||||||||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||||||||||
meta read-only |
Metadata describing the current result set.
|
||||||||||||||||||||||||||||||||||||||||
type |
The type of resource represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"description": "A collection (or list) of resources.",
"properties": {
"items": {
"description": "A collection of resources returned in the current result set.",
"items": {
"properties": {
"bodyContainsMagicBlank": {
"description": "Indicates if the HTML body of the contract contains one or more\n*magic blank* placeholder strings.",
"readOnly": true,
"type": "boolean"
},
"contacts": {
"description": "A collection of contacts associated with this contract",
"items": {
"$ref": "#/components/schemas/ContactCollectionMinimal"
},
"readOnly": true
},
"contractStatus": {
"$ref": "#/components/schemas/Contract/properties/contractStatus"
},
"created": {
"description": "The creation date of this contract.",
"format": "date-time",
"type": "string"
},
"expirationDate": {
"description": "The date on which this contract expires.",
"format": "date-time",
"type": "string"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"invoices": {
"description": "An array of linked invoices.",
"items": {
"$ref": "#/components/schemas/InvoiceMinimal"
},
"title": "Invoice",
"type": "array"
},
"isEditable": {
"description": "Whether the contract is able to be edited.",
"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"
},
"title": "Contract",
"type": "array"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"meta": {
"description": "Metadata describing the current result set.",
"properties": {
"currentPage": {
"description": "The current page of results returned.",
"type": "integer"
},
"rows": {
"description": "The number of rows returned per page for the current result set.",
"type": "integer"
},
"totalItems": {
"description": "The total number of items in the result set. This may be\naffected by active search/filter parameters.",
"type": "integer"
},
"totalPages": {
"description": "The total number of pages in the result set. This is affected by\nthe `rows` parameter (`totalItems / rows == totalPages`).",
"type": "integer"
}
},
"readOnly": true,
"type": "object"
},
"type": {
"description": "The type of resource represented.",
"enum": [
"contract-collection"
],
"example": "resource-type",
"title": "Resource Type",
"type": "string"
}
},
"required": [
"type",
"items"
],
"title": "Collection of Contracts",
"type": "object"
}