AgreementDocument Object
Contains information about a platform legal agreement document.
This object is used by the following operations:
API:
- POST /api/apis/versions/{APIVersionID}/legals (Adds information about a new legal agreement for the specified API version.)
- PUT /api/apis/versions/{APIVersionID}/legals/{LegalDocumentID}/details (Modifies information about a legal document for the specified API (name or description).
- PUT /api/apis/versions/{APIVersionID}/legals/{LegalDocumentID}/state ( Modifies the State of a legal document associated with a specified API version.)
Platform:
- POST /api/legals (Assigns a document as a legal agreement on the platform, and adds information about the agreement.)
- PUT /api/legals/{LegalDocumentID} (Updates information about the platform legal agreement. You can use this operation to change or deactivate the existing legal agreement.)
- GET /api/legals/{LegalDocumentID} (Returns a summary of information about a specified legal agreement document on the platform.)
Licenses:
- PUT /api/licenses/{LicenseID}/legals/{LegalDocumentID}/state in request)
- Operations that reference the License object
- Operations that reference the LicenseDetails object
The properties included in the AgreementDocument object are listed below. Properties are optional unless otherwise specified.
| Property | Type | Required | Description |
|---|---|---|---|
| LegalDocumentID | string | Required | The unique ID for the association of a specific legal document with a resource such as an API version, license, or the platform. Required when updating. |
| Name | string | Required | The user-defined name of the legal document. Required when adding or updating. |
| Description | string | Optional | A text description of the legal document. Required when adding or updating. |
| AgreementType | string | Required | The type of legal agreement; for example, com.soa.atmosphere.legals.eula. For valid values, see Legal Agreement Types. |
| ResourceID | string | Optional | A unique ID for the specific document resource. |
| ResourceType | string | Optional | A text description indicating the type of resource. |
| ContentPath | string | Required | The path (URI) to the location of the legal agreement (the HTML content). |
| MetadataResourceURI | string | Optional | The path (URI) to metadata about the legal agreement. |
| MetadataResourceVersion | integer | Optional | An indication of the version number for the legal agreement. |
| Active | boolean | Optional | Indicates whether the legal agreement is currently active. If not specified, defaults to false, indicating that the document is not active. |
| PrintContentPath | string | Required | The path (URI) to the location of a print resource for the legal document, such as a PDF. |
| PrintResourceURI | string | Optional | The path (URI) to metadata about the print version of the legal agreement. |
| PrintVersion | integer | Optional | An indication of the version number for the print version of the legal agreement. |
| DocumentState | string | Optional | The current activation state of the legal document; for example, com.soa.status.draft. For valid values, see Legal Document State. Required for PUT /api/apis/versions/{APIVersionID}/legals/{LegalDocumentID}/state, otherwise optional. |
| FileName | string | Optional | The filename for the display version of the legal agreement (not the print version). |
| Link | string | Optional | A link for the resource, if applicable. |
| TargetResources | TargetResources | Optional | Contains information about one or more resources associated with the current resource. Used only in response messages. |