Instance API

The Instance API is used during a Packaged CCE installation to select the name of the facility and instance for the deployment.

URL

https://<server>/unifiedconfig/config/instance

Operations

  • create: Creates one instance. Only one instance can be created.

  • delete: Deletes one instance.

  • get: Returns one instance, using the URL https://<server ip address>/unifiedconfig/config/instance/1.

  • list: Retrieves the instance from the database.

  • update: Updates one instance.

Note

The user performing the operation must be in the setup group for the instance Organizational Unit that is specified.

Parameters

  • refURL: The refURL of the instance. See Shared Parameters.

  • facilityName: Name of an existing facility Organizational Unit in Active Directory.

  • instanceName: Name of an existing instance Organizational Unit in Active Directory.

Example Get Response

Code Snippet
Copy<instance>
   <refURL>/unifiedconfig/config/instance/1</refURL>
   <facilityName>Lab</facilityName>
   <instanceName>pcce</instanceName>
</instance>