This document contains the complete resources listing of the APIs available. Click on a resource below to see additional details.
Displays the HTML homepage of the GroupWise API
available response representations:
| parameter | value | description |
|---|---|---|
|
type |
Type of object to search |
Get a list of Objects given the type
For example: /gwadmin-service/list/USER (will return all users)
Note: Attribute filtering is supported using this query (for example: ...?attribute=value).
available response representations:
| parameter | value | description |
|---|---|---|
|
base |
||
|
type |
Type of object to search |
Get a list of Objects given the type
For example: /gwadmin-service/list/USER (will return all users)
Note: Attribute filtering is supported using this query (for example: ...?attribute=value).
available response representations:
Generates and displays the API documentation (this document) taken from the WADL and programming documentation. Note: You can also use "application.wadl" resource to get the actual WADL document.
available response representations:
Used to run and track asynchronous operations. Use AsyncApi.run() to schedule a new asynchronous job. The job will be registered in the list of running jobs and will be queryable through the /async/{jobId} resource. After the jobs completes it will remain in the list of active jobs for REMOVE_DELAY (currently 60 seconds) at which time it is auto-removed. It can be removed before that time using the DELETE on /async/{jobId}.
Return the list of asynchronous jobs currently being run. Note that this list is filtered to only show jobs submitted by the admin that is making this request.
| parameter | value | description |
|---|---|---|
|
state |
Optional state value (i.e. COMPLETED, RUNNING) to filter the list of jobs by. |
available response representations:
| parameter | value | description |
|---|---|---|
|
id |
The job id |
Get a particular asynchronous job status
available response representations:
Delete a job. If the job is done, then it is removed. If the job is not yet done then a request will be sent to the thread executing the job to cancel it. Once the job is canceled it will remove itself from the job list.
Diagnostics resources
Return a map of attribute id to names.
| parameter | value | description |
|---|---|---|
|
locale |
available response representations:
Returns the list of available indices to query
available response representations:
| parameter | value | description |
|---|---|---|
|
index |
Reads objects from the specified index
| parameter | value | description |
|---|---|---|
|
attrs |
available response representations:
| parameter | value | description |
|---|---|---|
|
id |
The id of the record. This should be in the format "{record type}.{DRN}" |
Dump an object from the domain database identified by it's DRN and record type.
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
Get a list of Domains for this system.
Note: Attribute filtering is supported using this query (for example: ...?attribute=value)
available response representations:
Create a domain given the data. Note: The "rebuild" resource should be used to create the related database file (wpdomain.db) afterwards.
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
domain |
Domain name |
Delete a specific Domain given the domain name
available response representations:
Update a GroupWise Domain given the Domain data
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
Get a specific Domain given the name
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
Returns the address book fields available for adding to a view. Note that this excludes admin defined fields which can only be added to a view if they have been properly mapped to a directory attribute.
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
domain |
The name of the domain |
Get the address book labels defined for the domain
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
field |
The name of the field to set the label for |
|
|
domain |
The name of the domain |
Set the address book label for the given field
acceptable request representations:
available response representations:
Delete the address book label for the given field
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
domain |
Returns the address book view defined for the domain
available response representations:
Returns the address book view defined for the domain
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
domain |
The name of the domain |
Return the administrator for this domain
available response representations:
Set the administrator for this domain
acceptable request representations:
available response representations:
Clear the administrator for this domain
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
domain |
Get the Client Options under a specific Domain
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes to retrieve. If not specified all values will be retrieved |
available response representations:
Update the Client Options under a specific Domain
| parameter | value | description |
|---|---|---|
|
attrs |
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
domain |
Domain name |
Get all Custom Addresses under a specific Domain
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
domain |
Domain name |
Test the Custom Addresses that are associated with this Domain using the specified testAddress value. Returns a response that is the evaluated custom address test string
| parameter | value | description |
|---|---|---|
|
testAddress |
The testAddress value to use for testing |
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
domain |
The name of the domain |
List the gateway sub-directories for the domain.
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
domain |
The name of the domain |
Retrieve statistical information about the objects contained in this domain
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
domain |
The name of the domain |
List the links for this domain. Specify a 'direction' query parameter to read either the inbound or outbound links. If no direction is specified then all links are read (both inbound and outbound).
| parameter | value | description |
|---|---|---|
|
direction |
Specify "in" to read inbound domain links, "out" to read outbound domain links or do not specify to read all domain links. |
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
link |
||
|
domain |
Get the domain link between domainName and linkName
available response representations:
Update the domain link between domainName and linkName
| parameter | value | description |
|---|---|---|
|
attrs |
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
domain |
Domain name |
Rebuild a specific Domain given the Domain name. This command will rebuild the database (wpdomain.db) file and place it in the respective folder where it belongs. It will also ensure that the service is configured properly for this Domain. Note that this command requires an AdminService object be configured to communicate with the respective service.
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
domain |
Get the Access Control List for the domain
available response representations:
Update the Access Control List for the domain
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
Get all available Domain Attributes
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
Performs a query to find all the Gateways for this GroupWise system.
Note: Attribute filtering is supported using this query (for example: ...?attribute=value)
available response representations:
Create an Gateway given the Gateway data
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
gateway |
Gateway name |
|
|
domain |
Domain name |
Delete a specific Gateway given the name
available response representations:
Update a Gateway given the data
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
Get a specific Gateway given the name
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
gateway |
Gateway name |
|
|
domain |
Domain name |
Performs a query to find all the administrators for this gateway
available response representations:
Adds a new administrator to this gateway.
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
id |
||
|
gateway |
||
|
domain |
Remove an administrator member from this gateway
available response representations:
Remove an administrator member from this gateway
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
gateway |
Gateway name |
|
|
domain |
Domain Name |
Performs a query to find all the aliases for this gateway
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
gateway |
Gateway name |
|
|
domain |
Domain name |
List the classes of service for a specific gateway
available response representations:
Create a Gwia Class of Service for the specified gateway
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
cosname |
Class of Service name |
|
|
gateway |
Gateway name |
|
|
domain |
Domain name |
Get a specific Gateway given the name
available response representations:
Update a specific Class of Service given the name
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
Delete a specific Class of Service given the name
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
cosname |
Class of Service name |
|
|
gateway |
Post Office name |
|
|
domain |
Domain name |
List the members for a specific class of service
available response representations:
Adds a new member to this class of service. The 'id' field of groupMember is required and all other fields are ignored
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
member |
The id of the group member |
|
|
cosname |
Class of Service name |
|
|
gateway |
Gateway name |
|
|
domain |
Domain name |
Remove a member from this class of service by id
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
gateway |
Gateway name |
|
|
domain |
Domain name |
Recover the Access Control database for the specified gateway. This command will recover the database in place.
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
gateway |
Post Office name |
|
|
domain |
Domain name |
List the SMTP Relay Allow Exceptions for a specific gateway
available response representations:
Adds a new exception to the Smtp Relay Allow Exception list.
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
exceptionId |
||
|
gateway |
||
|
toUrl |
||
|
fromUrl |
||
|
domain |
Remove an exception from the Smtp Relay Allow Exception list.
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
gateway |
Post Office name |
|
|
domain |
Domain name |
List the SMTP Relay Prevent Exceptions for a specific gateway
available response representations:
Adds a new exception to the Smtp Relay Prevent Exception list.
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
gateway |
||
|
toUrl |
||
|
fromUrl |
||
|
domain |
Remove an exception from the Smtp Relay Prevent Exception list.
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
gateway |
Gateway name |
|
|
domain |
Domain name |
Validate the Access Control database for the specified gateway.
available response representations:
| parameter | value | description |
|---|---|---|
|
mta |
MTA name |
|
|
domain |
Domain name |
Delete an MTA given the name
available response representations:
Update a MTA given the data or create a new one if it doesn't exist
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
Get the MTA for a given domain
available response representations:
| parameter | value | description |
|---|---|---|
|
mta |
MTA name |
|
|
domain |
Domain name |
|
|
domain |
Domain name |
Manage a specific Post Office Agent
| parameter | value | description |
|---|---|---|
|
command |
Command to send to the agent START, RESTART, STOP, or STATUS (default) |
available response representations:
| parameter | value | description |
|---|---|---|
|
mta |
MTA name |
|
|
domain |
Domain name |
|
|
domain |
Domain name |
List the scheduled events for this MTA
available response representations:
Add or remove multiple scheduled events to this MTA in a single operation
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
mta |
MTA name |
|
|
domain |
Domain name |
|
|
domain |
Domain name |
|
|
eventName |
The name of the scheduled event to remove |
Link an existing scheduled event to this MTA
available response representations:
Unlink an existing scheduled event from this MTA
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
Get all PostOffices under a specific Domain.
Note: Attribute filtering is supported using this query (for example: ...?attribute=value)
available response representations:
Create a PostOffice given the Post Office data. Note: The "rebuild" resource should be used to create the related database file (wphost.db) afterwards.
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
Delete a specific Post Office given the Post Office name
available response representations:
Update a PostOffice given the Post Office data
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
Get a specific Post Office given the Domain name and Post Office name
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
Add a new gateway alias for this post office
acceptable request representations:
available response representations:
Performs a query to find all the aliases for this post office
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
type |
Gateway type |
Remove a gateway alias for this post office identified by it's gateway type.
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
postoffice |
Post office name |
|
|
domain |
Domain name |
Bump the number used by the GroupWise client to trigger a check for new versions of client software. The request entity is ignored. The response is NO_CONTENT on success or various error codes on failure.
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
Get the Client Options under a specific Post Office
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes to be retrieved. If not specified all available values will be retrieved |
available response representations:
Update the Client Options under a specific Post Office
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
postoffice |
The name of the post office |
|
|
domain |
The name of the domain |
Retrieve statistical information about the objects contained in this post office
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
postoffice |
Post office name |
|
|
domain |
Domain name |
Run mailbox maintenance for this post office
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
postoffice |
Post office name |
|
|
domain |
Domain name |
Convert an XML options file into a REST check options object
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
postoffice |
Post office name |
|
|
domain |
Domain name |
Convert REST check options into an options XML file suitable for use with GWCHECK
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
Rebuild a specific PostOffice given the Domain name and Post Office name. This command will rebuild the database (wphost.db) file and place it in the respective folder where it belongs. Note that this command requires an AdminService object be configured to communicate with the respective service.
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
Get the Access Control List for the Post Office
available response representations:
Update the Access Control List for the Post Office
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
Add / Remove LDAP Server associations. Two arrays of LDAP Server ID strings, one for adding and one for removing LDAP association objects.
acceptable request representations:
available response representations:
Get a list of all the LDAP Server Associations on a particular Post Office
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
Synchronize all users under a GroupWise Post Office with their respective LDAP Users
| parameter | value | description |
|---|---|---|
|
commit |
flag (default is false) if the synchronize changes should be committed. |
|
|
showAll |
flag (default is false) to show all results |
|
|
includeRegEx |
include regular expression filter |
|
|
excludeRegEx |
exclude regular expression filter |
|
|
forceRemove |
flag (default is false) if all users should be removed |
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
Synchronize (to obtain a text report) all users under a GroupWise Post Office with their respective LDAP Users
| parameter | value | description |
|---|---|---|
|
commit |
flag (default is false) if the synchronize changes should be committed |
|
|
showAll |
flag (default is false) to show all results |
|
|
includeRegEx |
include regular expression filter |
|
|
excludeRegEx |
exclude regular expression filter |
|
|
forceRemove |
flag (default is false) if all users should be removed |
available response representations:
| parameter | value | description |
|---|---|---|
|
domain |
Domain name |
|
|
postoffice |
Post Office Name |
|
|
domain |
Domain Name |
Set a Time Stamp value for all the users on a Post Office given the data
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
||
|
domain |
Get all Groups (a.k.a. Distribution Lists) under a specific PostOffice.
Note: Attribute filtering is supported using this query (for example: ...?attribute=value)
available response representations:
Create a Group given the data
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
||
|
domain |
||
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
group |
Group name |
Delete a specific Group given the name
available response representations:
Update an exiting Group given the data
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
Get a specific Group given the name
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
||
|
domain |
||
|
postoffice |
Post office name |
|
|
domain |
Domain name |
|
|
group |
Group name |
Get the list of allowed email address for this user including nickname and gateway alias email addresses.
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
||
|
domain |
||
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
group |
Group name |
Update the list of group memberships for this group.
acceptable request representations:
available response representations:
Add to the list of group memberships for this group.
acceptable request representations:
Return the list of groups that this group is a member of
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
||
|
domain |
||
|
postoffice |
||
|
domain |
||
|
groupid |
||
|
group |
Remove from the list of group memberships for this group.
Update the participation in the specified group for this group.
acceptable request representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
||
|
domain |
||
|
postoffice |
The name of the post office |
|
|
domain |
The name of the domain |
|
|
group |
The name of the group |
Retrieve statistical information about the objects related to this group.
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
||
|
domain |
||
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
group |
Group name |
Adds a new member to this group. The 'id' field of groupMember is required, 'participation' is optional (will default to PRIMARY) and all other fields are ignored
acceptable request representations:
available response representations:
Performs a query to find all the Users (members) belonging to this group (distribution list)
available response representations:
Update group membership add/remove/update in a batch operation
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
||
|
domain |
||
|
member |
Group Member ID |
|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
group |
Group name |
Get a particular group member by id
available response representations:
Remove a member from this group by id
available response representations:
Update the participation of a group member. The 'id' and 'participation' fields of the groupMember object must be specified. All other fields are ignored
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
||
|
domain |
||
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
group |
Group name |
Performs a query to find all the Nicknames for this group
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
||
|
domain |
||
|
postoffice |
||
|
domain |
||
|
group |
Get the access control list for the group
available response representations:
Update the access control list for the group
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
||
|
domain |
||
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
oldgroup |
The current name of the Group to be renamed |
|
|
newgroup |
The new name that the Group should be renamed to |
Rename a Group (Distribution List)
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
Get all Libraries under a specific PostOffice.
Note: Attribute filtering is supported using this query (for example: ...?attribute=value)
available response representations:
Create a Library given the data
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
library |
Library name |
|
|
domain |
Domain name |
Delete a Library given the name
available response representations:
Update a Library given the data
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
Get a specific Library given the name
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
library |
Library name |
|
|
domain |
Domain name |
Returns the list of access rights for this library
available response representations:
Adds access rights for a user
acceptable request representations:
available response representations:
Adds access rights for a user
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
userid |
User ID |
|
|
library |
Library name |
|
|
domain |
Domain name |
Adds access rights for a user
available response representations:
Adds access rights for a user
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
library |
Library name |
|
|
domain |
Domain name |
Returns the list of storage areas used by this library
available response representations:
Enable a storage area for use by the library
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
||
|
library |
||
|
domain |
Apply a list of batch add/remove operation to the storage area access list
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
area |
The name of the storage area to disable |
|
|
library |
Library name |
|
|
domain |
Domain name |
Disable a storage area for use by the library
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
The name of the post office |
|
|
library |
The name of the library |
|
|
domain |
The name of the domain |
Retrieve statistical information about the objects related to this library.
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post office name |
|
|
library |
Library name |
|
|
domain |
Domain name |
Run mailbox maintenance for this library
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post office name |
|
|
library |
Library name |
|
|
domain |
Domain name |
Convert an XML options file into a REST check options object
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post office name |
|
|
library |
Library name |
|
|
domain |
Domain name |
Convert REST check options into an options XML file suitable for use with GWCHECK
acceptable request representations:
available response representations:
REST API for interacting with library areas
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
library |
Library name |
|
|
domain |
Domain name |
Get a list of all library areas defined in the system.
available response representations:
Create a new Library Area
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
library |
Library name |
|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
area |
Library area name |
|
|
library |
Library name |
|
|
domain |
Domain name |
Delete the Library Area with the specified name
available response representations:
Update a Library Area with the specified name
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
Get a specific library area given the name
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
Get all Nicknames under a specific PostOffice.
Note: Attribute filtering is supported using this query (for example: ...?attribute=value)
available response representations:
Create a Nickname given the data
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
nickname |
Nickname name |
|
|
domain |
Domain name |
Delete a Nickname given the name
available response representations:
Update a Nickname given the data
| parameter | value | description |
|---|---|---|
|
attrs |
acceptable request representations:
available response representations:
Get a specific Nickname given the nickname name
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
The name of the post office |
|
|
nickname |
The name of the nickname |
|
|
domain |
The name of the domain |
Retrieve statistical information about the objects related to this nickname.
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
Get all Post Office Agents under a specific PostOffice.
Note: Attribute filtering is supported using this query (for example: ...?attribute=value)
available response representations:
Create a Post Office Agent given the data
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
poa |
Post Office Agent name |
|
|
domain |
Domain name |
Delete a specific Post Office Agent given the name
available response representations:
Update a Post Office Agent given the data
| parameter | value | description |
|---|---|---|
|
attrs |
acceptable request representations:
available response representations:
Get a specific Post Office Agent given the name
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
poa |
Post Office Agent name |
|
|
domain |
Domain name |
Manage a specific Post Office Agent
| parameter | value | description |
|---|---|---|
|
command |
command to send to the agent START, RESTART, STOP, CREATE, DELETE, or STATUS (default) |
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
poa |
Post Office Agent name (usually "POA") |
|
|
domain |
Domain name |
List the scheduled events for a specific Post Office Agent
available response representations:
List the scheduled events for a specific Post Office Agent
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
poa |
The Post Office Agent name |
|
|
domain |
Domain name |
|
|
eventName |
Name of the scheduled event to remove |
Link an existing scheduled event to this Post Office Agent
available response representations:
Unlink an existing scheduled event from this Post Office Agent
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
Get all Resources under a specific PostOffice.
Note: Attribute filtering is supported using this query (for example: ...?attribute=value)
available response representations:
Create a Resource given the data
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
resource |
Resource name |
|
|
domain |
Domain name |
Delete a Resource given the name
available response representations:
Update a Resource given the name and properties object
| parameter | value | description |
|---|---|---|
|
attrs |
acceptable request representations:
available response representations:
Get a specific Resource given the name
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
resource |
Resource name |
|
|
domain |
Domain name |
Get the Client Options under a specific Resource
| parameter | value | description |
|---|---|---|
|
attrs |
available response representations:
Update the Client Options under a specific Resource
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post office name |
|
|
resource |
Resource name |
|
|
domain |
Domain name |
Get the list of allowed email address for this user including nickname and gateway alias email addresses.
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
resource |
Resource name |
|
|
domain |
Domain name |
Update the list of group memberships for this resource.
acceptable request representations:
available response representations:
Add to the list of group memberships for this resource.
acceptable request representations:
Performs a query to find all the Group Associations for this Resource
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
||
|
resource |
||
|
domain |
||
|
groupid |
Remove from the list of group memberships for this resource.
Update the participation in the specified group for this resource.
acceptable request representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
The name of the post office |
|
|
resource |
The name of the resource |
|
|
domain |
The name of the domain |
Retrieve statistical information about the objects related to this resource.
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post office name |
|
|
resource |
Resource name |
|
|
domain |
Domain name |
Run mailbox maintenance for this user
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post office name |
|
|
resource |
Resource name |
|
|
domain |
Domain name |
Convert an XML options file into a REST check options object
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post office name |
|
|
resource |
Resource name |
|
|
domain |
Domain name |
Convert REST check options into an options XML file suitable for use with GWCHECK
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
resource |
Resource name |
|
|
domain |
Domain name |
Performs a query to find all the Nicknames for this Resource
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post office name |
|
|
resource |
Resource name |
|
|
domain |
Domain name |
Get the restore area for this resource
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post Office NAme |
|
|
resource |
Resource Name |
|
|
domain |
Domain Name |
Sends a command to the Post Office Agent to perform a Restore operation for the specified resource.
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
Get the Sync Contexts for this PostOffice.
Note: Attribute filtering is supported using this query (for example: ...?attribute=value)
available response representations:
Create a Sync Context given the data
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
context |
Sync Context name |
|
|
domain |
Domain name |
Synchronize all users under this SyncContext with their respective LDAP Users
| parameter | value | description |
|---|---|---|
|
commit |
Flag (default is false) if the synchronize changes should be committed. |
|
|
showAll |
Flag (default is false) to show all results |
|
|
includeRegEx |
Include regular expression filter |
|
|
excludeRegEx |
Exclude regular expression filter |
|
|
forceRemove |
Flag (default is false) if all users should be removed |
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
||
|
context |
||
|
domain |
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
synccontext |
Sync Context name |
|
|
domain |
Domain name |
Delete a Sync Context given the name
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
syncserver |
Sync Server name |
Update a Sync Server given the data
acceptable request representations:
available response representations:
Get a specific Sync Server on a Post Office
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
Get all Users under a specific PostOffice.
Note: Attribute filtering is supported using this query (for example: ...?attribute=value)
available response representations:
Create a User given the data. Required fields: domainName, postOfficeName, name
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
user |
User name |
Delete a User given the name
available response representations:
Update a User given the data. Required fields: domainName, postOfficeName, fileId, name
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
Get a specific User given the name
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
postoffice |
Post office name |
|
|
domain |
Domain name |
|
|
user |
User name |
Performs a query to find all the groups administered by this user
available response representations:
Update the list of groups administered by this user.
acceptable request representations:
available response representations:
Add to the list of groups administered by this user.
acceptable request representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
postoffice |
Post office name |
|
|
domain |
Domain name |
|
|
group |
The id of the group to be removed |
|
|
user |
User name |
Remove from the list of groups administered by this user.
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
user |
User name |
Add a new gateway alias for this user
acceptable request representations:
available response representations:
Performs a query to find all the aliases for this user
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
type |
Gateway type |
|
|
user |
User name |
Remove a gateway alias for this user identified by it's gateway type.
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
user |
User name |
Get the Client Options under a specific User
| parameter | value | description |
|---|---|---|
|
attrs |
available response representations:
Update the Client Options under a specific User
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
postoffice |
Post office name |
|
|
domain |
Domain name |
|
|
user |
User name |
Get the list of allowed email address for this user including nickname and gateway alias email addresses.
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
user |
User name |
Performs a query to find all the group memberships for this User
available response representations:
Update the list of group memberships for this user.
acceptable request representations:
available response representations:
Add to the list of group memberships for this user.
acceptable request representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
postoffice |
||
|
domain |
||
|
groupid |
||
|
user |
Remove from the list of group memberships for this user.
Update the participation in the specified group for this user.
acceptable request representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
postoffice |
The name of the post office |
|
|
domain |
The name of the domain |
|
|
user |
The name of the user |
Retrieve statistical information about the objects related to this user.
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
postoffice |
Post office name |
|
|
domain |
Domain name |
|
|
user |
User name |
Run mailbox maintenance for this user
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
postoffice |
Post office name |
|
|
domain |
Domain name |
|
|
user |
User name |
Convert an XML options file into a REST check options object
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
postoffice |
Post office name |
|
|
domain |
Domain name |
|
|
user |
User name |
Convert REST check options into an options XML file suitable for use with GWCHECK
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
user |
User name |
Performs a query to find all the Nicknames for this user
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
user |
User name |
Performs a query to find all the Resources for this user
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
postoffice |
Post office name |
|
|
domain |
Domain name |
|
|
user |
User name |
Get the restore area for this user
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
postoffice |
Post Office NAme |
|
|
domain |
Domain Name |
|
|
user |
User Name |
Sends a command to the Post Office Agent to perform a Restore operation for the specified user.
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
user |
User name |
Synchronize a single GroupWise User with its respective LDAP User
| parameter | value | description |
|---|---|---|
|
commit |
(default is false) boolean value if the synchronize changes should be committed |
|
|
showAll |
flag (default is false) to show all results |
|
|
changedAttrs |
A comma separated list of attributes, if none of these attributes listed are in the syncServer information the sync will not be performed. This is to optimize updates to the user where changes do not effect sync. Passing nothing will cause the check to be ignored |
available response representations:
| parameter | value | description |
|---|---|---|
|
postoffice |
Post Office name |
|
|
domain |
Domain Name |
|
|
postoffice |
Post Office name |
|
|
domain |
Domain name |
|
|
user |
User name |
Synchronize (to obtain a text report) a single GroupWise User with its respective LDAP User
| parameter | value | description |
|---|---|---|
|
commit |
(default is false) boolean value if the synchronize changes should be committed |
|
|
showAll |
(default is false) boolean value if all results should be shown |
|
|
changedAttrs |
A comma separated list of attributes, if none of these attributes listed are in the syncServer information the sync will not be performed. This is to optimize updates to the user where changes do not effect sync. Passing nothing will cause the check to be ignored |
available response representations:
Get the agent configuration. NOTE: This is a service utility method that only gets invoked by the system. Services for managing the remote nodes configuration, files, and calls are available other places in the API. See SystemApi.
| parameter | value | description |
|---|---|---|
|
reload |
available response representations:
Create a new System object in the database with related Domain and files as defined in the SystemConfigInfo object
acceptable request representations:
available response representations:
Returns the default system Time Zone records for this system. Returns a StringMapEntry
available response representations:
Get the Local Admin Services that are defined in this system and match the clients Host name or IP Address.
Note: Attribute filtering is supported using this query (for example: ...?attribute=value)
available response representations:
Send Browse Files Command NOTE: This is a service utility method that only gets invoked by the system. Services for managing the remote nodes configuration, files, and calls are available other places in the API. See AdminServicesApi.
available response representations:
Send Manage Service Command NOTE: This is a service utility method that only gets invoked by the system. Services for managing the remote nodes configuration, files, and calls are available other places in the API. See PoasApi, MtasApi.
available response representations:
Send Manage Upload Command NOTE: This is a service utility method that only gets invoked by the system. Services for managing the remote nodes configuration, files, and calls are available other places in the API. See AdminSericesApi.
available response representations:
| parameter | value | description |
|---|---|---|
|
id |
object identifier in TDPN format (Consisting of the Type, Domain, PostOffice, & Name notation), or the GroupWise GUID identifier |
Delete an object given the object TDPN
available response representations:
Get an object given the object identifier
For example: /gwadmin-service/object/USER.MyDomain.MyPostOffice.MyUser (will return the user MyUser)
available response representations:
API for creating, updating and deleting custom preference objects.
Preference objects are custom records that are associated with the primary domain and a particular admin user. This api only supports listing custom preferences "owned" by the currently authenticated admin user. Similarly, any preferences created through this API will be "owned" by the authenticated administrator and will not be visible to any other admins through this API.
List the custom preferences for the current admin user.
available response representations:
Create a new custom preference
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
group |
The preference to create. Must specify a 'group' and 'name' |
List the custom preferences for the current admin user in the specified property group.
available response representations:
Create a new custom preference
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
name |
The preference name |
|
|
group |
The preference group |
Delete the preference with the specified name
available response representations:
Update the preference specified by the given group and name
| parameter | value | description |
|---|---|---|
|
attrs |
acceptable request representations:
available response representations:
Return the preference specified by the given group and name
available response representations:
Update the System object
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
Get the System object
available response representations:
Returns the Domain that this service is connected to
available response representations:
Returns the default system Time Zone records for this system. Returns a StringMapEntry
available response representations:
Return the list of expired objects on the system.
| parameter | value | description |
|---|---|---|
|
domainname |
Optional. Filter by domain name. |
|
|
postofficename |
Optional. Filter by post office name. |
|
|
expiretime |
Optional. Use an explicit expiration cut-off time. The time is specified as a java long time. |
available response representations:
Retrieve statistical information about the objects contained in this system.
available response representations:
Returns the Languages for this system. Returns an IntegerMapEntry
available response representations:
| parameter | value | description |
|---|---|---|
|
listId |
Numeric ID of an object type |
Returns the list of available columns for a particular object
available response representations:
Returns the Locale Language Description for this system. Returns a String
available response representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
path |
Create a read-only "Recover" connection to a backup copy of a Domain database
available response representations:
available response representations:
Get the list of pending operations on the system.
available response representations:
| parameter | value | description |
|---|---|---|
|
id |
The id of the object with the pending operation |
Undo a pending operation
Retry a pending operation
Returns the Platforms for this system. Returns an IntegerMapEntry
available response representations:
Create a connection to a backup copy of a domain database
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
connectionid |
A unique ID representing the connection to a backup copy of a domain database that should be closed |
Delete a connection to a backup copy of a domain database
available response representations:
| parameter | value | description |
|---|---|---|
|
connectionid |
The connection ID of the Recover connection to use. |
|
|
accountid |
Name of the account in TDPN format. |
Recover a deleted GroupWise account from a backup copy of the GroupWise primary domain database.
Once the account has been recovered, you can use the command:
domains/{domain}/postoffices/{postoffice}/users/{user}/restoremailbox
or
domains/{domain}/postoffices/{postoffice}/resources/{resource}/restoremailbox
to restore the contents of the mailbox from your backup system.
available response representations:
| parameter | value | description |
|---|---|---|
|
connectionid |
A unique ID representing the connection to the backup copy of a domain database |
|
|
resource |
The ID of the resource in TDPN (Type.Domain.PostOffice.Name) format |
Get a specific Resource from a backup copy of the domain database given the connection ID and the resource ID.
available response representations:
| parameter | value | description |
|---|---|---|
|
connectionid |
A unique ID representing the connection to the backup copy of a domain database |
Get a list of resources. All resources that are visible in the backup copy of the domain will be listed if no search criteria are specified
available response representations:
| parameter | value | description |
|---|---|---|
|
connectionid |
A unique ID representing the connection to the backup copy of a domain database |
|
|
user |
The ID of the user in TDPN (Type.Domain.PostOffice.Name) format |
Get a specific User from a backup copy of the domain database given the connection ID and the user ID.
available response representations:
| parameter | value | description |
|---|---|---|
|
connectionid |
A unique ID representing the connection to the backup copy of a domain database |
Get a list of users. All users that are visible in the backup copy of the domain will be listed if no search criteria are specified
available response representations:
Get the referenced Access Controls for the System
available response representations:
Modify the referenced Access Controls for the System
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
|
Email address |
Lookup a single user by their email address
available response representations:
Get the Admin Services that are defined in this system.
Note: Attribute filtering is supported using this query (for example: ...?attribute=value)
available response representations:
Create a Admin Service given the data
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
adminservice |
Admin Service name |
Delete a Admin Service given the name
available response representations:
Update a Admin Service given the data
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
Get a specific Admin Service given the name
available response representations:
| parameter | value | description |
|---|---|---|
|
adminservice |
Get the list of certificates from the specified AdminService. These are the files located under in the "certificates" folder where the rest service is running or the folder specified by the com.novell.gw.admin.certificatesOverride.
available response representations:
Upload a certificate file to the specified AdminService. These are the files located under in the "certificates" folder where the rest service is running or the folder specified by the com.novell.gw.admin.certificatesOverride.
available response representations:
| parameter | value | description |
|---|---|---|
|
adminservice |
||
|
filename |
Delete a certificate file from the specified AdminService. These are the files located under in the "certificates" folder where the rest service is running or the folder specified by the com.novell.gw.admin.certificatesOverride.
available response representations:
| parameter | value | description |
|---|---|---|
|
adminservice |
Admin Service name |
Get the local configuration of the Admin Service
available response representations:
| parameter | value | description |
|---|---|---|
|
adminservice |
Admin Service name |
Get the list of roots or volumes available on the machine where the admin service is running
| parameter | value | description |
|---|---|---|
|
queryFolders |
If true, includes sub-folders in the results. (defaults to true) |
|
|
queryFiles |
If true, includes files in the results. (defaults to false) |
|
|
queryFilter |
A string containing a wild card filter. Multiple wild cards can be included by separating them with the comma "," character. If a filter in specified, results will include items that satisfy any of the wild cards |
available response representations:
| parameter | value | description |
|---|---|---|
|
root |
The volume or file root on which the folder exists |
|
|
adminservice |
Admin Service name |
Get the list of folders and files that exist in the root directory of a volume
| parameter | value | description |
|---|---|---|
|
queryFolders |
If true, includes sub-folders in the results. (defaults to true) |
|
|
queryFiles |
If true, includes files in the results. (defaults to false) |
|
|
queryFilter |
A string containing a wild card filter. Multiple wild cards can be included by separating them with the comma "," character. If a filter in specified, results will include items that satisfy any of the wild cards |
available response representations:
| parameter | value | description |
|---|---|---|
|
root |
The volume or file root on which the folder exists |
|
|
adminservice |
Admin Service name |
|
|
folders |
The path to the folder in which to search. The path specified should be relative to the root |
Get the list of folders and files that exist in the specified folder
| parameter | value | description |
|---|---|---|
|
queryFolders |
If true, includes sub-folders in the results. (defaults to true) |
|
|
queryFiles |
If true, includes files in the results. (defaults to false) |
|
|
queryFilter |
A string containing a wild card filter. Multiple wild cards can be included by separating them with the comma "," character. If a filter in specified, results will include items that satisfy any of the wild cards |
available response representations:
| parameter | value | description |
|---|---|---|
|
adminservice |
the admin service to manage |
Manage a specific Admin Service
| parameter | value | description |
|---|---|---|
|
command |
command to send to the agent START, RESTART, STOP, STATUS (default) |
available response representations:
| parameter | value | description |
|---|---|---|
|
adminservice |
Admin Service name |
Get the referencing Domain for the Admin Service
available response representations:
Modify the referencing Domain for the Admin Service
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
adminservice |
Admin Service name |
Get the referencing Post Offices for the Admin Service
available response representations:
Modify the referencing Post Offices for the Admin Service
acceptable request representations:
available response representations:
Get the Calendar Publishing Host that are defined in this system.
Note: Attribute filtering is supported using this query (for example: ...?attribute=value)
available response representations:
Create a Calendar Publishing given the data
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
calPubHost |
Calendar Publishing Host name |
Delete a Calendar Publishing given the name
available response representations:
Update a Calendar Publishing given the data
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
Get a specific Calendar Publishing Host given the name
available response representations:
Get the Custom Addresses that are defined in this system.
Note: Attribute filtering is supported using this query (for example: ...?attribute=value)
available response representations:
Create an addressing rule given the data
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
customAddress |
Custom Address name |
Delete the addressing rule given the name
available response representations:
Update a GroupWise addressing rule given the addressing rule data
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
Get a specific Custom Address given the name
available response representations:
| parameter | value | description |
|---|---|---|
|
customAddress |
Addressing Rule name |
|
|
domain |
Domain name |
Associate the specified Custom Address with a Domain
available response representations:
Remove the Custom Address association with a Domain
available response representations:
Test a single Custom Address that is defined in the system using the specified testAddress, serachString, and replaceString values. Returns a response that is the evaluated custom address test string
| parameter | value | description |
|---|---|---|
|
testAddress |
The testAddress value to use |
|
|
searchString |
The search value to use |
|
|
replaceString |
The replace value to use |
available response representations:
Test the Custom Addresses that are defined in this System using the specified testAddress value. Returns a response that is the evaluated custom address test string
| parameter | value | description |
|---|---|---|
|
testAddress |
The testAddress value to use for testing |
available response representations:
API for listing, creating, updating, deleting global signatures
Return the list of defined global signatures
available response representations:
Create a new global signature
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
name |
Global signature name |
Delete the global signature with the specified name
Update or create a global signature
acceptable request representations:
Retrieve a global signature object by name.
available response representations:
Get the Internet Domains that are defined in this system.
Note: Attribute filtering is supported using this query (for example: ...?attribute=value)
available response representations:
Create an Internet Domain given the data
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
internetdomain |
Internet domain name |
Delete an Internet Domain given the name
available response representations:
Update an Internet Domain given the data
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
Get a specific Internet Domain given the name
available response representations:
Get the list of LDAP servers
available response representations:
Create an LDAP Server object given the data
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
ldapserver |
LDAP Server name |
Delete an LDAP Server object given the name
available response representations:
Update an LDAP Server object given the data
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
Get a specific LDAP Server object given the name
available response representations:
| parameter | value | description |
|---|---|---|
|
ldapserver |
LDAP Server name |
Get a list of all the LDAP Server Associations on a particular LDAP Server
available response representations:
Add / Remove LDAP Server associations. Two arrays of PostOffice ID strings, one for adding and one for removing LDAP association objects.
acceptable request representations:
available response representations:
Get the list of records on the system with a move user status.
| parameter | value | description |
|---|---|---|
|
domainname |
Optional. Filter by domain name. |
|
|
postofficename |
Optional. Filter by post office name. |
|
|
name |
Optional. Filter by user name. |
available response representations:
Move one or more users to a new post office.
The request object must contain the id of the destination post office as well as a list containing one or more user ids. Each user entry in the source list can optionally specify whether or not they want to create a nickname on the source post office and a new owner for resources.
{
"postOfficeId": "POST_OFFICE.Dom1.Po2",
"sources": [
{"id": "USER.Dom1.Po1.User1", "createNickname": "true"},
{"id": "USER.Dom1.Po1.User2"},
{"id": "RESOURCE.Dom1.Po1.Rsrc1", "resourceOwnerId": "USER.Dom1.Po1.User3"},
]
}
If the request is well formed and the destination post office is valid then a 200 OK response will be returned with a response entity that encodes the success or failure of the individual move operations. The caller MUST examine the response entity to determine if the move succeeded for a given and not just assume that a 200 OK means that the move succeeded.
The response entity will contain the number of user moves that succeeded in addition to a collection of errors that were encountered for user moves that failed. The caller can determine that the entire move succeeded if the number of users that succeeded in the response match the number of users that were requested to move in the request entity. Individual failures are identified by the id that was passed into the move request.
When moving a resource, the new owner field is required. The owner must be the id of a user that exists on the destination post office. If the resource owner is not specified then the move will fail with a status of FORBIDDEN and an error code of INVALID_OWNER (0xDB04).
When moving a user, the new resource owner field is only required in cases where the user owns resources on the source post office. In this case, the new resource owner must be another user on the source post office that the owned resources will be reassigned to. If the user owns resources and no resource owner is specified the move will fail with a status of FORBIDDEN and an error code of OWNED_RSRC_EXISTS (0xDB09).
acceptable request representations:
available response representations:
Clear all complete user move statuses
| parameter | value | description |
|---|---|---|
|
id |
The id of the move status object |
Clear a single user move status
| parameter | value | description |
|---|---|---|
|
clearincomplete |
true/false case insensitive. Indicates if the status should be cleared even if it is not completed. If this flag is not set and the status is not complete a FORBIDDEN status will be returned. |
| parameter | value | description |
|---|---|---|
|
id |
Run an action on the specified user move status. Actions are one of (case-insensitive):
| parameter | value | description |
|---|---|---|
|
action |
| parameter | value | description |
|---|---|---|
|
id |
The id of the user move status object |
Return the list of pending items for the user move status
available response representations:
REST API for interacting with Restore areas
Get a list of all Restore areas defined in the system.
available response representations:
Create a new Restore Area
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
area |
Restore area name |
Delete the Restore Area with the specified name
available response representations:
Update a Restore Area with the specified name
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
Get a specific Restore area given the name
available response representations:
| parameter | value | description |
|---|---|---|
|
area |
RestoreArea name |
List the membership of this restore area
available response representations:
Add a member to the restore area
acceptable request representations:
available response representations:
Remove a member from the restore area
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
member |
Specifies the id of the member to remove |
|
|
area |
RestoreArea name |
Remove a member from the restore area
available response representations:
Returns a list of all scheduled event actions defined
in the system. You can optionally filter the list by passing
attribute/value
pairs in the query parameter (i.e. ?action=REDUCE)
available response representations:
Create a new Scheduled Event Action record
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
actionName |
Event Action name |
Delete the scheduled Event Action with the specified name
available response representations:
Update the scheduled Event Action with the specified name
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
Get a specific {@link com.novell.gw.api.gwobject.ScheduledEventAction} given the name
available response representations:
Get a list of all scheduled events defined in the system. You can optionally filter the list by passing attribute/value pairs
in the
query parameter (i.e. ?eventType=MAINTENANCE)
available response representations:
Create a new Scheduled Event
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
eventName |
Event name |
Delete the Scheduled Event with the specified name
available response representations:
Update a Scheduled Event with the specified name
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
Get a specific ScheduledEvent given the name
available response representations:
| parameter | value | description |
|---|---|---|
|
eventName |
Scheduled Event name |
Returns the list of Scheduled Event Actions that are associated with this event
available response representations:
Performs a batch update on the list of associated Scheduled Event Actions by applying all of the adds and removes specified in the update object
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
actionName |
Scheduled Event Action name |
|
|
eventName |
Scheduled Event name |
Create a new association between a Scheduled Event and a Scheduled Event Action
available response representations:
Remove an association between a Scheduled Event and a Scheduled Event Action
available response representations:
REST API for interacting with software areas
Get a list of all software areas defined in the system.
available response representations:
Create a new Software Area
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
area |
Software area name |
Delete the Software Area with the specified name
available response representations:
Update a Software Area with the specified name
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
Get a specific software area given the name
available response representations:
| parameter | value | description |
|---|---|---|
|
area |
The name of the software area. |
Update the files in the software area by copying them from:
acceptable request representations:
available response representations:
Get the SyncServers that are defined in this system.
Note: Attribute filtering is supported using this query (for example: ...?attribute=value)
available response representations:
Create a SyncServer given the data
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
syncserver |
Sync Server name |
Delete a SyncServer given the name
available response representations:
Update a SyncServer given the data
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
Get a specific SyncServer given the name
available response representations:
| parameter | value | description |
|---|---|---|
|
syncserver |
| parameter | value | description |
|---|---|---|
|
extend |
available response representations:
| parameter | value | description |
|---|---|---|
|
syncserver |
available response representations:
| parameter | value | description |
|---|---|---|
|
syncserver |
available response representations:
| parameter | value | description |
|---|---|---|
|
syncserver |
Sync Server name |
Return the Sync Contexts associated with this Sync Server
available response representations:
Get a list of Timezones given in the system
available response representations:
Create a Timezone given the data
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
timezone |
Timezone abbreviation value |
|
|
resource |
Timezone abbreviation value |
Delete a Resource given the name
available response representations:
Update a Resource given the name and properties object
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
Get a specific Timezone given the value
available response representations:
Get the list of Trusted Applications
available response representations:
Create a Trusted Application object given the data.
Upon success the newly created key value is returned
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
trustedapp |
Trusted Application name |
Delete a Trusted Application object given the name
available response representations:
Update a Trusted Application object given the data.
| parameter | value | description |
|---|---|---|
|
attrs |
A comma separated list of attributes that should be updated. If not specified all values will be updated |
acceptable request representations:
available response representations:
Get a specific Trusted Application object given the name
available response representations: