GET >> /list/{type} >> Get a list of Objects given the type For example: /gwadmin-service/list/USER (will return all users)
GET >> /list/{type}/{base} >> Get a list of Objects given the type For example: /gwadmin-service/list/USER (will return all users)
GET >> /application >> 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.
GET >> /async?state >> 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}.
GET >> /async/{id} >> Get a particular asynchronous job status
DELETE >> /async/{id} >> 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.
GET >> /diagnostics/attributes?locale >> Return a map of attribute id to names.
GET >> /diagnostics/index >> Returns the list of available indices to query
GET >> /diagnostics/index/{index}?attrs >> Reads objects from the specified index
GET >> /diagnostics/object/{id} >> Dump an object from the domain database identified by it's DRN and record type.
GET >> /domains >> Get a list of Domains for this system.
POST >> /domains >> Create a domain given the data. Note: The "rebuild" resource should be used to create the related database file (wpdomain.db) afterwards.
DELETE >> /domains/{domain} >> Delete a specific Domain given the domain name
PUT >> /domains/{domain} >> Update a GroupWise Domain given the Domain data
GET >> /domains/{domain} >> Get a specific Domain given the name
GET >> /domains/{domain}/addressbook/fields >> 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.
GET >> /domains/{domain}/addressbook/labels >> Get the address book labels defined for the domain
PUT >> /domains/{domain}/addressbook/labels/{field} >> Set the address book label for the given field
DELETE >> /domains/{domain}/addressbook/labels/{field} >> Delete the address book label for the given field
GET >> /domains/{domain}/addressbook/view >> Returns the address book view defined for the domain
PUT >> /domains/{domain}/addressbook/view >> Returns the address book view defined for the domain
GET >> /domains/{domain}/administrator >> Return the administrator for this domain
PUT >> /domains/{domain}/administrator >> Set the administrator for this domain
DELETE >> /domains/{domain}/administrator >> Clear the administrator for this domain
GET >> /domains/{domain}/clientoptions?attrs >> Get the Client Options under a specific Domain
PUT >> /domains/{domain}/clientoptions?attrs >> Update the Client Options under a specific Domain
GET >> /domains/{domain}/customaddresses >> Get all Custom Addresses under a specific Domain
GET >> /domains/{domain}/customaddresses/test?testAddress >> 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
GET >> /domains/{domain}/gatewaysubdirs >> List the gateway sub-directories for the domain.
GET >> /domains/{domain}/info >> Retrieve statistical information about the objects contained in this domain
GET >> /domains/{domain}/links?direction >> 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).
GET >> /domains/{domain}/links/{link} >> Get the domain link between domainName and linkName
PUT >> /domains/{domain}/links/{link} >> Update the domain link between domainName and linkName
POST >> /domains/{domain}/rebuild >> 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.
GET >> /domains/{domain}/refaccesscontrols >> Get the Access Control List for the domain
PUT >> /domains/{domain}/refaccesscontrols >> Update the Access Control List for the domain
GET >> /domains/attributes >> Get all available Domain Attributes
GET >> /domains/{domain}/gateways >> Performs a query to find all the Gateways for this GroupWise system.
POST >> /domains/{domain}/gateways >> Create an Gateway given the Gateway data
DELETE >> /domains/{domain}/gateways/{gateway} >> Delete a specific Gateway given the name
PUT >> /domains/{domain}/gateways/{gateway} >> Update a Gateway given the data
GET >> /domains/{domain}/gateways/{gateway} >> Get a specific Gateway given the name
GET >> /domains/{domain}/gateways/{gateway}/administrators >> Performs a query to find all the administrators for this gateway
POST >> /domains/{domain}/gateways/{gateway}/administrators >> Adds a new administrator to this gateway.
DELETE >> /domains/{domain}/gateways/{gateway}/administrators/{id} >> Remove an administrator member from this gateway
PUT >> /domains/{domain}/gateways/{gateway}/administrators/{id} >> Remove an administrator member from this gateway
GET >> /domains/{domain}/gateways/{gateway}/aliases >> Performs a query to find all the aliases for this gateway
GET >> /domains/{domain}/gateways/{gateway}/classofservice >> List the classes of service for a specific gateway
POST >> /domains/{domain}/gateways/{gateway}/classofservice >> Create a Gwia Class of Service for the specified gateway
GET >> /domains/{domain}/gateways/{gateway}/classofservice/{cosname} >> Get a specific Gateway given the name
PUT >> /domains/{domain}/gateways/{gateway}/classofservice/{cosname} >> Update a specific Class of Service given the name
DELETE >> /domains/{domain}/gateways/{gateway}/classofservice/{cosname} >> Delete a specific Class of Service given the name
GET >> /domains/{domain}/gateways/{gateway}/classofservice/{cosname}/members >> List the members for a specific class of service
POST >> /domains/{domain}/gateways/{gateway}/classofservice/{cosname}/members >> Adds a new member to this class of service. The 'id' field of groupMember is required and all other fields are ignored
DELETE >> /domains/{domain}/gateways/{gateway}/classofservice/{cosname}/members/{member} >> Remove a member from this class of service by id
POST >> /domains/{domain}/gateways/{gateway}/recoverDb >> Recover the Access Control database for the specified gateway. This command will recover the database in place.
GET >> /domains/{domain}/gateways/{gateway}/smtprelayallowexception >> List the SMTP Relay Allow Exceptions for a specific gateway
POST >> /domains/{domain}/gateways/{gateway}/smtprelayallowexception >> Adds a new exception to the Smtp Relay Allow Exception list.
DELETE >> /domains/{domain}/gateways/{gateway}/smtprelayallowexception/{fromUrl}/{toUrl} >> Remove an exception from the Smtp Relay Allow Exception list.
GET >> /domains/{domain}/gateways/{gateway}/smtprelaypreventexception >> List the SMTP Relay Prevent Exceptions for a specific gateway
POST >> /domains/{domain}/gateways/{gateway}/smtprelaypreventexception >> Adds a new exception to the Smtp Relay Prevent Exception list.
DELETE >> /domains/{domain}/gateways/{gateway}/smtprelaypreventexception/{fromUrl}/{toUrl} >> Remove an exception from the Smtp Relay Prevent Exception list.
DELETE >> /domains/{domain}/mta >> Delete an MTA given the name
PUT >> /domains/{domain}/mta >> Update a MTA given the data or create a new one if it doesn't exist
GET >> /domains/{domain}/mta >> Get the MTA for a given domain
GET >> /domains/{domain}/mta/manage?command >> Manage a specific Post Office Agent
GET >> /domains/{domain}/mta/refevents >> List the scheduled events for this MTA
PUT >> /domains/{domain}/mta/refevents >> Add or remove multiple scheduled events to this MTA in a single operation
PUT >> /domains/{domain}/mta/refevents/{eventName} >> Link an existing scheduled event to this MTA
DELETE >> /domains/{domain}/mta/refevents/{eventName} >> Unlink an existing scheduled event from this MTA
GET >> /domains/{domain}/postoffices >> Get all PostOffices under a specific Domain.
POST >> /domains/{domain}/postoffices >> Create a PostOffice given the Post Office data. Note: The "rebuild" resource should be used to create the related database file (wphost.db) afterwards.
DELETE >> /domains/{domain}/postoffices/{postoffice} >> Delete a specific Post Office given the Post Office name
PUT >> /domains/{domain}/postoffices/{postoffice} >> Update a PostOffice given the Post Office data
GET >> /domains/{domain}/postoffices/{postoffice} >> Get a specific Post Office given the Domain name and Post Office name
POST >> /domains/{domain}/postoffices/{postoffice}/maintenance >> Run mailbox maintenance for this post office
GET >> /domains/{domain}/postoffices/{postoffice}/synchronize?commit&showAll&includeRegEx&excludeRegEx&forceRemove >> Synchronize all users under a GroupWise Post Office with their respective LDAP Users
GET >> /domains/{domain}/postoffices/{postoffice}/synchronizetext?commit&showAll&includeRegEx&excludeRegEx&forceRemove >> Synchronize (to obtain a text report) all users under a GroupWise Post Office with their respective LDAP Users
DELETE >> /domains/{domain}/postoffices/{postoffice}/groups/{group} >> Delete a specific Group given the name
PUT >> /domains/{domain}/postoffices/{postoffice}/groups/{group} >> Update an exiting Group given the data
GET >> /domains/{domain}/postoffices/{postoffice}/groups/{group} >> Get a specific Group given the name
PUT >> /domains/{domain}/postoffices/{postoffice}/groups/{group}/groupmemberships >> Update the list of group memberships for this group.
POST >> /domains/{domain}/postoffices/{postoffice}/groups/{group}/groupmemberships >> Add to the list of group memberships for this group.
GET >> /domains/{domain}/postoffices/{postoffice}/groups/{group}/groupmemberships >> Return the list of groups that this group is a member of available response representations.
POST >> /domains/{domain}/postoffices/{postoffice}/groups/{group}/members >> 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.
GET >> /domains/{domain}/postoffices/{postoffice}/groups/{group}/members >> Performs a query to find all the Users (members) belonging to this group (distribution list).
PUT >> /domains/{domain}/postoffices/{postoffice}/groups/{group}/members >> Update group membership add/remove/update in a batch operation.
GET >> /domains/{domain}/postoffices/{postoffice}/groups/{group}/members/{member} >> Get a particular group member by id
DELETE >> /domains/{domain}/postoffices/{postoffice}/groups/{group}/members/{member} >> Remove a member from this group by id
PUT >> /domains/{domain}/postoffices/{postoffice}/groups/{group}/members/{member} >> Update the participation of a group member. The 'id' and 'participation' fields of the groupMember object must be specified. All other fields are ignored
DELETE >> /domains/{domain}/postoffices/{postoffice}/libraries/{library} >> Delete a Library given the name
PUT >> /domains/{domain}/postoffices/{postoffice}/libraries/{library} >> Update a Library given the data
GET >> /domains/{domain}/postoffices/{postoffice}/libraries/{library} >> Get a specific Library given the name
GET >> /domains/{domain}/postoffices/{postoffice}/libraries/{library}/accessrights >> Returns the list of access rights for this library
POST >> /domains/{domain}/postoffices/{postoffice}/libraries/{library}/accessrights >> Adds access rights for a user
PUT >> /domains/{domain}/postoffices/{postoffice}/libraries/{library}/accessrights >> Adds access rights for a user
DELETE >> /domains/{domain}/postoffices/{postoffice}/libraries/{library}/storageareas/{area} >> Delete the Library Area with the specified name
PUT >> /domains/{domain}/postoffices/{postoffice}/libraries/{library}/storageareas/{area} >> Update a Library Area with the specified name
GET >> /domains/{domain}/postoffices/{postoffice}/libraries/{library}/storageareas/{area} >> Get a specific library area given the name
DELETE >> /domains/{domain}/postoffices/{postoffice}/nicknames/{nickname} >> Delete a Nickname given the name
PUT >> /domains/{domain}/postoffices/{postoffice}/nicknames/{nickname} >> Update a Nickname given the data
GET >> /domains/{domain}/postoffices/{postoffice}/nicknames/{nickname} >> Get a specific Nickname given the nickname name
DELETE >> /domains/{domain}/postoffices/{postoffice}/poas/{poa} >> Delete a specific Post Office Agent given the name
PUT >> /domains/{domain}/postoffices/{postoffice}/poas/{poa} >> Update a Post Office Agent given the data
GET >> /domains/{domain}/postoffices/{postoffice}/poas/{poa} >> Get a specific Post Office Agent given the name
DELETE >> /domains/{domain}/postoffices/{postoffice}/resources/{resource} >> Delete a Resource given the name
PUT >> /domains/{domain}/postoffices/{postoffice}/resources/{resource} >> Update a Resource given the name and properties object
GET >> /domains/{domain}/postoffices/{postoffice}/resources/{resource} >> Get a specific Resource given the name
PUT >> /domains/{domain}/postoffices/{postoffice}/resources/{resource}/groupmemberships >> Update the list of group memberships for this resource.
POST >> /domains/{domain}/postoffices/{postoffice}/resources/{resource}/groupmemberships >> Add to the list of group memberships for this resource.
GET >> /domains/{domain}/postoffices/{postoffice}/resources/{resource}/groupmemberships >> Performs a query to find all the Group Associations for this Resource
DELETE >> /domains/{domain}/postoffices/{postoffice}/users/{user} >> Delete a User given the name
PUT >> /domains/{domain}/postoffices/{postoffice}/users/{user} >> Update a User given the data. Required fields: domainName, postOfficeName, fileId, name
GET >> /domains/{domain}/postoffices/{postoffice}/users/{user} >> Get a specific User given the name
GET >> /domains/{domain}/postoffices/{postoffice}/users/{user}/administeredgroups >> Performs a query to find all the groups administered by this user
PUT >> /domains/{domain}/postoffices/{postoffice}/users/{user}/administeredgroups >> Update the list of groups administered by this user.
POST >> /domains/{domain}/postoffices/{postoffice}/users/{user}/administeredgroups >> Add to the list of groups administered by this user.
GET >> /domains/{domain}/postoffices/{postoffice}/users/{user}/groupmemberships >> Performs a query to find all the group memberships for this User
PUT >> /domains/{domain}/postoffices/{postoffice}/users/{user}/groupmemberships >> Update the list of group memberships for this user.
POST >> /domains/{domain}/postoffices/{postoffice}/users/{user}/groupmemberships >> Add to the list of group memberships for this user.
DELETE >> /system/customaddresses/{customAddress} >> Delete the addressing rule given the name
PUT >> /system/customaddresses/{customAddress} >> Update a GroupWise addressing rule given the addressing rule data
GET >> /system/customaddresses/{customAddress} >> Get a specific Custom Address given the name
DELETE >> /system/globalsignatures/{name} >> Delete the global signature with the specified name
PUT >> /system/globalsignatures/{name} >> Update or create a global signature
GET >> /system/globalsignatures/{name} >> Retrieve a global signature object by name.
DELETE >> /system/internetdomains/{internetdomain} >> Delete an Internet Domain given the name
PUT >> /system/internetdomains/{internetdomain} >> Update an Internet Domain given the data
GET >> /system/internetdomains/{internetdomain} >> Get a specific Internet Domain given the name
GET >> /system/moverequests?domainname&postofficename&name >> Get the list of records on the system with a move user status.
POST >> /system/moverequests?domainname&postofficename&name >> 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.
DELETE >> /system/moverequests?domainname&postofficename&name >> Clear all complete user move statuses
DELETE >> /system/restoreareas/{area} >> Delete the Restore Area with the specified name
PUT >> /system/restoreareas/{area} >> Update a Restore Area with the specified name
GET >> /system/restoreareas/{area} >> Get a specific Restore area given the name