Document class
The Document class represents a generic document.
Document class APIs
The following tables list the basic APIs, operation APIs, and relationship APIs for the Document class.
Basic APIs
Name | HTTP | URI | Description |
|---|---|---|---|
search | POST | Searches for Document objects. |
Operation APIs
The Document class has no operation APIs.
Relationship APIs
The Document class has no relationship APIs.
Document class relationships and attributes
The following tables list the relationships and attributes of the Document class.
Relationships
Name | Type | Multi- | Description |
|---|---|---|---|
errors | 0..* |
| |
cloudClass | 1 | Fully-qualified name of the class to which the object belongs | |
provider | 1 | Provider that created the object | |
tags | 0..* | Tags associated with the object |
Attributes
Name | Type | Multi- | Description |
|---|---|---|---|
author | String | 1 | The name of the person who wrote the document. |
category | String | 1 | The category of the content of the document file, for example a ServiceBlueprint or a ServiceInfrastructureBlueprint |
content | String | 1 | The content of the document |
documentDate | 1 | The date and time the document was created | |
purpose | String | 0..1 | The purpose of the content of the document file, for example a ServiceModel or a FunctionalModel (for service blueprints) |
schemaVersion | String | 0..1 | The schema version of the document |
description | String | 0..1 | Text that describes the object |
guid | String | 1 | Globally unique identifier for the object |
labels | String | 0..* |
|
modifiedDate | 0..1 | Date the Cloudobject was modified | |
name | String | 1 | Human-readable name of the object |