3.1 Concepts

3.1.1.1 DomainRef

Domains are identified by a UUID value. Web services operations that need to identify a domain use the DomainRef type. A DomainRef contains only the information required to uniquely identify a domain; the UUID. The other properties of a domain, such as its labels, are not part of a DomainRef type.

DomainRef domainReference = new DomainRef();
domainReference.setUuid("29499ec3-4ded-4138-9ea4-cc1f5dbf8db1");

An example method that uses a DomainRef type is the delete domain method:

DomainOperations domainOperations = new DomainOperationService().getDomainOperations();
domainOperations.deleteDomain(domainReference);

3.1.1.2 Domain

A Domain contains all the information about a domain, including the UUID. For operations that require or return all the domain properties, a Domain is used.

An example that uses the Domain type is the list domains method:

DomainOperations domainOperations = new DomainOperationService().getDomainOperations();
Domain[] results = domainOperations.listDomains();

3.1.2.1 ContextTemplateRef

ContextTemplateRef templateReference = new ContextTemplateRef();
templateReference.setUuid("96c512a7-e44b-47d5-a70d-0ef2c0283f25");
templateReference.setDomain(domainReference);

It is valid for two templates in different domains to have the same UUID value. The templates that are automatically installed when the first domain is created all have fixed UUID values. For example, the standard template has the UUID value 474dbb07-718b-4c4e-8f43-d2b723469573. Using these predefined UUID values means there is no need to look up a context template UUID before creating a ContextTemplateRef type.

3.1.2.2 ContextTemplate

A ContextTemplate contains all the information about a context template, including the UUID and domain. For operations that require or return all the context template properties, a ContextTemplate is used.

3.1.3.1 ContextInstanceRef

ContextInstanceRef contextReference = new ContextInstanceRef();
contextReference.setUuid("a3c41a86-a1b4-4d5d-9fe5-f4077bbc2b17");

3.1.3.2 ContextInstance

A ContextInstance contains all the information about a context, including the UUID and labels. For operations that require or return all the context properties, a ContextInstance is used.

3.1.4.1 DocumentRoleRef

Document roles are identified by a UUID value within the owning domain. Web services operations that need to identify a role use the DocumentRoleRef type. A DocumentRoleRef contains the information required to uniquely identify a role; the UUID and the owning domain. The other properties of a role, such as its labels and features, are not part of a DocumentRoleRef type.

DocumentRoleRef roleReference = new DocumentRoleRef();
roleReference.setUuid("96c512a7-e44b-47d5-a70d-0ef2c0283f25");
roleReference.setDomain(domainReference);

It is valid for two roles in different domains to have the same UUID value. The roles that are automatically installed when the first domain is created all have fixed UUID values. For example, the contributor role has the UUID value a456140d-24dc-4cc2-8f23-1a72fb6c2d81. Using these predefined UUID values means there is no need to look up a context template UUID before creating a ContextTemplateRef type.

3.1.4.2 DocumentRole

A DocumentRole contains all the information about a role, including the UUID and domain. For operations that require or return all the document role properties a DocumentRole is used.

3.1.5.1 DocumentRightRef

DocumentRightRef rightReference = new DocumentRightRef();
rightReference.setUuid("35aa8611-abff-43e3-a5ae-ffe71345d9d4");

3.1.5.2 DocumentRight

A DocumentRight contains all the information about a right, including the UUID, account and role. For operations that require or return all the right properties, a DocumentRight is used.