Webservice: Tenant

handling of tenants [Commercial editions only]

Index Method Request(s) Response Description
1 listTenants sid
 tenant gets all existing tenants
2 getTenantById sid
tenantId
 tenant gets a specific tenant by it's identifier
3 storeTenant sid
tenant
 tenantId creates/updates a tenant; returns the identifier of the created/updated instance
4 getTenant sid
name
 tenant gets a specific tenant by it's name
5 deleteTenant sid
tenantId
 deletes an existing tenant

Method #1: listTenants

gets all existing tenants

Request

Name Type Required Multiple Description
     sid
String Y

Response

Name Type Required Multiple Description
     tenant
WSTenant Y Y
          id
Long Y unique identifier
          lastModified
String the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
          name
String Y
          displayName
String
          street
String
          postalCode
String
          city
String
          state
String
          country
String
          email
String
          telephone
String
          type
Int Y must be 0
          maxUsers
Integer maximum number of users
          maxSessions
Integer maximum number of concurrent sessions
          maxRepoDocs
Long maximum number of documents
          enabled
Int Y 1 = enabled, 0 = disabled
          expire
String an expiration date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
          maxRepoSize
Long maximum repository's size expressed in MB

Method #2: getTenantById

gets a specific tenant by it's identifier

Request

Name Type Required Multiple Description
     sid
String Y
     tenantId
Long Y

Response

Name Type Required Multiple Description
     tenant
WSTenant Y
          id
Long Y unique identifier
          lastModified
String the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
          name
String Y
          displayName
String
          street
String
          postalCode
String
          city
String
          state
String
          country
String
          email
String
          telephone
String
          type
Int Y must be 0
          maxUsers
Integer maximum number of users
          maxSessions
Integer maximum number of concurrent sessions
          maxRepoDocs
Long maximum number of documents
          enabled
Int Y 1 = enabled, 0 = disabled
          expire
String an expiration date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
          maxRepoSize
Long maximum repository's size expressed in MB

Method #3: storeTenant

creates/updates a tenant; returns the identifier of the created/updated instance

Request

Name Type Required Multiple Description
     sid
String Y
     tenant
WSTenant Y
          id
Long Y unique identifier
          lastModified
String the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
          name
String Y
          displayName
String
          street
String
          postalCode
String
          city
String
          state
String
          country
String
          email
String
          telephone
String
          type
Int Y must be 0
          maxUsers
Integer maximum number of users
          maxSessions
Integer maximum number of concurrent sessions
          maxRepoDocs
Long maximum number of documents
          enabled
Int Y 1 = enabled, 0 = disabled
          expire
String an expiration date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
          maxRepoSize
Long maximum repository's size expressed in MB

Response

Name Type Required Multiple Description
     tenantId
Long Y

Method #4: getTenant

gets a specific tenant by it's name

Request

Name Type Required Multiple Description
     sid
String Y
     name
String Y

Response

Name Type Required Multiple Description
     tenant
WSTenant Y
          id
Long Y unique identifier
          lastModified
String the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
          name
String Y
          displayName
String
          street
String
          postalCode
String
          city
String
          state
String
          country
String
          email
String
          telephone
String
          type
Int Y must be 0
          maxUsers
Integer maximum number of users
          maxSessions
Integer maximum number of concurrent sessions
          maxRepoDocs
Long maximum number of documents
          enabled
Int Y 1 = enabled, 0 = disabled
          expire
String an expiration date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
          maxRepoSize
Long maximum repository's size expressed in MB

Method #5: deleteTenant

deletes an existing tenant

Request

Name Type Required Multiple Description
     sid
String Y
     tenantId
Long Y