SOAP API Reference
Authorize
This method retrieves a user profile which has the APIToken property for use in subsequent calls.
User Authorize(string username, string password);
Parameter |
Data Type |
Nullable |
Required |
Description |
username |
string |
No |
Yes |
Username used to login |
password |
string |
No |
Yes |
Password |
User object containing information about the user.
This object has the APIToken property. In order to authorize API calls that require an APIContext, use the APIToken property from the User object for the APIContext.UserToken property.
GetSupportedLanguages
This method retrieves the list of supported languages for the system.
Language[] GetSupportedLanguages();
Returns supported languages as a Language business objects.
GetSupportedTimeZones
This method retrieves the list of supported time zones for the system.
Timezone[] GetSupportedTimeZones();
Returns supported time zones as a Timezone business objects.
GetKnownEvents
This method retrieves the list of known events codes for the system.
String[] GetKnownEvents(APIContext context);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
Returns known system events as a list.
GetKnownAssetUploadParameters
This method retrieves the list of known asset upload parameters for the system.
String[] GetKnownAssetUploadParameters(APIContext context);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
Returns known asset upload parameters as a list.
GetUserList
This method retrieves the list of users in the system that is both active and disabled and requires partner key credentials.
User[] GetUserList(APIContext context, Int32? accountId, String searchText);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
accountId |
Integer |
Yes |
No |
The account id to search under. |
searchText |
String |
Yes |
No |
The text to search in the full name or email address. |
Returns a list of users in the system as User business objects.
GetAccountDetails
This method retrieves a small set of details about an account.
Account GetAccountDetails(APIContext context, Int32 accountId);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
accountId |
Integer |
Yes |
No |
The account id. |
Returns an account in the system as Account business objects.
GetAccountList
This method retrieves the list of all the accounts and requires partner key credentials.
AccountProfile[] GetAccountList(APIContext context, Int32? accountId, String accountName, String domain, String ownerEmail, String ownerName, Boolean? bitActive);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
accountId |
Integer |
Yes |
No |
The account id. |
accountName |
String |
Yes |
No |
The text to search in the account name. |
domain |
String |
Yes |
No |
The text to search in the domain. |
ownerEmail |
String |
Yes |
No |
The text to search in the owner's email. |
ownerName |
String |
Yes |
No |
The text to search in the owner's name. |
bitActive |
Boolean |
Yes |
No |
Return active accounts only (true). |
Returns a list of accounts in the system as Account Profile business objects.
GetAccountProfile
This method retrieves the account profile for the specified account ID and requires partner key credentials.
AccountProfile GetAccountProfile(APIContext context, Int32 accountId);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
accountId |
Integer |
No |
Yes |
The account id. |
Returns a single account profile from the system as an Account Profile business object.
GetAccountModuleList
This method retrieves the list of all the account modules enabled on the account.
AccountModule[] GetAccountModuleList(APIContext context, int? accountId = null);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
accountId |
Int32 |
Yes |
No |
The account id to pull modules for (if null the current account is used). |
Returns a list of account modules as Account Module business objects.
UpdateAccountModules
Turns particular modules on and off for a given account.
void UpdateAccountModules(APIContext context, int accountId, UpdateAccountModule[] modules);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
accountId |
Int32 |
No |
Yes |
The account id to pull modules for (if null the current account is used). |
modules |
UpdateAccountModule[] |
No |
Yes |
The account modules to update. |
GetAccountSettings
This method retrieves the list of all the account settings.
AccountSetting[] GetAccountSettings(APIContext context);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
Returns a list of account settings as Account Setting business objects.
SetAccountSetting
This method sets the value of an Account Setting.
bool SetAccountSetting(APIContext context, int settingId, string value);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
settingId |
Integer |
No |
Yes |
Setting id. |
value |
String |
No |
Yes |
The value of the setting. |
Returns true if setting the account setting value was successful.
AddAccount
This method retrieves the list of all the accounts and requires partner key credentials.
Account AddAccount(APIContext context, Boolean active, String ownerEmail, Int32 packageId, AccountType? type, String name, String domain, String headerText, Int32 userLimit, Int32 storage, Int32 storagePerUser);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
active |
Boolean |
No |
Yes |
True to activate the account. |
ownerEmail |
String |
No |
Yes |
Existing user's email address to add the person as an owner. |
packageId |
Integer |
No |
Yes |
Package specifications the account would use. |
type |
AccountType |
Yes |
Yes |
Sets the type of account being created (See AccountType in User Defined Data Type document) |
name |
String |
No |
Yes |
Name of the account. |
domain |
String |
No |
Yes |
Access domain of the account. |
headerText |
Integer |
Yes |
No |
Text for site branding. |
userLimit |
Integer |
No |
Yes |
Max user limit for the account. |
storage |
Integer64 |
No |
Yes |
Max storage limit for the account. |
storagePerUser |
Integer64 |
No |
Yes |
Max storage per user for each user on the account. |
Returns the successfully added account as Account business object.
UpdateAccount
This method updates the account information and requires partner key credentials.
Account UpdateAccount(APIContext context, Boolean? active, String ownerEmail, Int32? packageId, AccountType? type, String name, String domain, String headerText, Int32? userLimit, Int32? storage, Int32? storagePerUser);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
accountId |
Integer |
No |
Yes |
Account id to update. |
active |
Boolean |
Yes |
No |
True to activate the account. |
ownerEmail |
String |
Yes |
No |
Existing user's email address to add the person as an owner. |
packageId |
Integer |
Yes |
No |
Package specifications the account would use. |
type |
AccountType |
Yes |
Yes |
Sets the type of account being created (See AccountType in User Defined Data Type document) |
name |
String |
Yes |
No |
Name of the account. |
domain |
String |
Yes |
No |
Access domain of the account. |
headerText |
Integer |
Yes |
No |
Text for branding the site instead of an image. |
userLimit |
Integer |
Yes |
No |
Max user limit for the account. |
storage |
Integer |
Yes |
No |
Max storage limit for the account. |
storagePerUser |
Integer |
Yes |
No |
Max storage per user for each user on the account. |
Returns the successfully updated account as Account business object.
RemoveAccount
This method removes the account and requires partner key credentials.
DANGER: This action is not reversible.
Account RemoveAccount(APIContext context, Int32 accountId);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
accountId |
Integer |
No |
Yes |
The account id to remove from the system. |
Returns the successfully removed account as Account business object.
GetAccountMembershipList
This method retrieves the list of domains the user is associated with and requires partner key credentials.
AccountUser[] GetAccountMembershipList(APIContext context, Int32? userId);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
userId |
Integer |
Yes |
No |
The user id to retrieve the account domains of. If null the currently logged in user's results are returned. |
Returns the list of domains that are associated with the user as AccountUser business objects
GetAccountAliasList
This method retrieves the valid domain list for an account and requires partner key credentials.
AccountAlias[] GetAccountAliasList(APIContext context, Int32 accountId);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
accountId |
Integer |
No |
Yes |
The account id to search the valid account domains. |
Returns the list valid domains configured for this account as AccountAlias business objects
AddAccountAlias
This method adds the account domain in the specific account and requires partner key credentials.
AccountAlias AddAccountAlias(APIContext context, Int32 accountId, String domain);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
accountId |
Integer |
No |
Yes |
The account id to add the account domain under. |
domain |
String |
No |
Yes |
The url of the domain. |
Returns the successfully added account domain as AccountAlias business object.
UpdateAccountAlias
This method updates the account alias and requires partner key credentials.
AccountAlias UpdateAccountAlias(APIContext context, Int32 accountAliasId, Int32 accountId, String domain);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
accountAliasId |
Integer |
No |
Yes |
Account domain id to update. |
accountId |
Integer |
No |
Yes |
The account id which has the account domain. |
domain |
String |
No |
Yes |
The url of the domain. |
Returns the updated account domain as AccountAlias business object.
RemoveAccountAlias
This method removes the account domain and requires partner key credentials.
DANGER: This action is not reversible.
AccountAlias RemoveAccountAlias(APIContext context, Int32 accountAliasId);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
accountAliasId |
Integer |
No |
Yes |
The account domain id to remove from the system. |
Returns the successfully removed account domain as AccountAlias business object.
GetPartnerKeyList
This method retrieves the list of partner keys and requires partner key credentials.
PartnerKey[] GetPartnerKeyList(APIContext context);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
Returns the list of partner keys as PartnerKey business objects.
AddPartnerKey
This method creates the partner key and allows the option to enable or disable partner API and hosted API calls which requires Hosted API authorization.
PartnerKey AddPartnerKey(APIContext context, String name, Boolean isPartnerAPIEnabled, Boolean isHostedAPIEnabled, String password);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
name |
String |
No |
Yes |
The name of the partner key. |
isPartnerAPIEnabled |
Boolean |
No |
Yes |
True to allow partner api calls. |
isHostedAPIEnabled |
Boolean |
No |
Yes |
True to allow hosted api calls. |
password |
String |
No |
Yes |
The password to allow access to hosted and partner api calls. |
Returns the successfully created partner key as PartnerKey business object.
UpdatePartnerKey
This method updates the partner key and requires partner key credentials.
PartnerKey UpdatePartnerKey(APIContext context, Integer partnerKeyId, String name, Boolean isPartnerAPIEnabled, Boolean isHostedAPIEnabled, String password);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
partnerKeyId |
String |
No |
Yes |
The partner key id. |
name |
String |
Yes |
No |
The name of the partner key. |
isPartnerAPIEnabled |
Boolean |
Yes |
No |
True to allow partner api calls. |
isHostedAPIEnabled |
Boolean |
Yes |
No |
True to allow hosted api calls. |
password |
String |
Yes |
No |
The password to allow access to hosted and partner api calls. |
Returns the successfully updated partner key as PartnerKey business object.
RemovePartnerKey
This method removes the partner key and requires partner key credentials.
PartnerKey RemovePartnerKey(APIContext context, Int32 partnerKeyId);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
partnerKeyId |
Integer |
No |
Yes |
The partner key id. |
Returns the successfully removed partner key as PartnerKey business object.
GetRecycleBinItemList
This method retrieves the recycle bin item list and requires partner key credentials.
RecycleBinItem[] GetRecycleBinItemList(APIContext context, Int32? accountId, Int32? userId, Int32? referenceId, RecycleBinItemType? itemType, String searchText);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
accountId |
Integer |
Yes |
No |
The account id to search under. |
userId |
Integer |
Yes |
No |
The user who removed the item. |
referenceId |
Integer |
Yes |
No |
The reference id of the item. |
referenceType |
RecycleBinItemType |
Yes |
No |
The specific type of elements to search for. |
searchText |
String |
Yes |
No |
Searches the name of the item. |
Returns the list of all the recycle bin items based on the parameters as RecycleBinItem business objects.
RestoreRecycleBinItem
This method allows restoring the removed items from the recycle bin and requires partner key credentials.
RecycleBinItem RestoreRecycleBinItem(APIContext context, Int32 itemId);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
itemId |
Integer |
No |
Yes |
The recycle bin record id to restore. |
Returns the successfully restored item as RecycleBinItem business object.
RemoveRecycleBinItem
This method allows purging one or all the items from the recycle bin and requires partner key credentials.
DANGER: This action is not reversible.
RecycleBinItem RemoveRecycleBinItem(APIContext context, Int32? itemId);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
itemId |
Integer |
Yes |
No |
If the recycle bin id is supplied then the item will be purged from the recycle bin list. If the recycle bin id is not supplied all the items will be purged from the recycle bin list. |
Returns the successfully removed recycle bin item as RecycleBinItem business object.
GetAccountCallbackList
This method retrieves the account callbacks list.
Callback[] GetAccountCallbackList(APIContext context, String urlSearchText, String eventSearchText, Boolean? isEnabled);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
urlSearchText |
String |
Yes |
No |
The url of the callback. |
eventSearchText |
String |
Yes |
No |
The event added on the callback. |
isEnabled |
Boolean |
Yes |
No |
The enabled, disabled or both types of callback. |
Returns the list of all the account callbacks based on the parameters as Callback business objects.
AddAccountCallback
This method creates the account callback.
Callback AddAccountCallback(APIContext context, String url, CallbackMethod method, Boolean isEnabled, Boolean shouldRetry, Int32? maxAttempts, Int32? retryDelay, String[] eventFilter);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
url |
String |
No |
Yes |
The callback url. |
method |
CallbackMethod |
No |
Yes |
Type of callback method. |
isEnabled |
Boolean |
No |
Yes |
True if the callback is enabled. |
shouldRetry |
Boolean |
No |
Yes |
True if retry option is enabled. |
maxAttempts |
Integer |
Yes |
No |
Maximum number of attempts to hit the callback. |
retryDelay |
Integer |
Yes |
No |
The number of minutes to retry after attempt fails. |
eventFilter |
String |
Yes |
No |
The events to capture. (See GetKnownEvents). Supports custom events to be captured as well. |
Returns the successfully created account callback as a Callback business object.
UpdateAccountCallback
This method updates the account callback.
Callback UpdateAccountCallback(APIContext context, Int32 callbackId, String url, CallbackMethod method, Boolean? isEnabled, Boolean? shouldRetry, Int32? maxAttempts, Int32? retryDelay, String[] eventFilter);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
callbackId |
Integer |
No |
Yes |
This is the callback id. |
url |
String |
No |
Yes |
The callback url. |
method |
CallbackMethod |
No |
Yes |
Type of callback method. |
isEnabled |
Boolean |
Yes |
No |
True if the callback is enabled. |
shouldRetry |
Boolean |
Yes |
No |
True if retry option is enabled. |
maxAttempts |
Integer |
Yes |
No |
Maximum number of attempts to hit the callback. |
retryDelay |
Integer |
Yes |
No |
The number of minutes to retry after attempt fails. |
eventFilter |
String[] |
No |
Yes |
The events to capture. (See GetKnownEvents).
Supports custom events to be captured as well.
The new events will replace the previous events.
If nothing is passed in the callbacks will be removed.
|
Returns the successfully updated account callback as a Callback business object.
RemoveAccountCallback
This method removes the account callback.
Callback RemoveAccountCallback(APIContext context, Int32 callbackId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
callbackId |
Integer |
No |
Yes |
The callback id. |
Returns the successfully removed account callback as a Callback business object.
GetCallbackList
This method retrieves the callback list and requires partner key credentials.
Callback[] GetCallbackList(APIContext context, Int32? accountId, String urlSearchText, String eventSearchText, Boolean? isEnabled);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
accountId |
Integer |
Yes |
No |
The account id. |
urlSearchText |
String |
Yes |
No |
The url of the callback. |
eventSearchText |
String |
Yes |
No |
The event added on the callback. |
isEnabled |
Boolean |
Yes |
No |
The enabled, disabled or both types of callback. |
Returns the list of all the callbacks based on the parameters as Callback business objects.
AddCallback
This method creates the callback and requires partner key credentials.
Callback AddCallback(APIContext context, Int32? accountId, String url, CallbackMethod method, Boolean isEnabled, Boolean shouldRetry, Int32? maxAttempts, Int32? retryDelay, String[] eventFilter);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
accountId |
Integer |
Yes |
No |
Allows the callback to be associated with an account. |
url |
String |
No |
Yes |
The callback url. |
method |
CallbackMethod |
No |
Yes |
Type of callback method. |
isEnabled |
Boolean |
No |
Yes |
True if the callback is enabled. |
shouldRetry |
Boolean |
No |
Yes |
True if retry option is enabled. |
maxAttempts |
Integer |
Yes |
No |
Maximum number of attempts to hit the callback. |
retryDelay |
Integer |
Yes |
No |
The number of minutes to retry after attempt fails. |
eventFilter |
String |
Yes |
No |
The events to capture. (See GetKnownEvents). Supports custom events to be captured as well. |
Returns the successfully created callback as a Callback business object.
UpdateCallback
This method updates the callback and requires partner key credentials.
Callback UpdateCallback(APIContext context, Int32 callbackId, Int32? accountId, String url, CallbackMethod method, Boolean? isEnabled, Boolean? shouldRetry, Int32? maxAttempts, Int32? retryDelay, String[] eventFilter);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
callbackId |
Integer |
No |
Yes |
This is the callback id. |
accountId |
Integer |
Yes |
No |
Allows the callback to be associated with an account. |
url |
String |
No |
Yes |
The callback url. |
method |
CallbackMethod |
No |
Yes |
Type of callback method. |
isEnabled |
Boolean |
Yes |
No |
True if the callback is enabled. |
shouldRetry |
Boolean |
Yes |
No |
True if retry option is enabled. |
maxAttempts |
Integer |
Yes |
No |
Maximum number of attempts to hit the callback. |
retryDelay |
Integer |
Yes |
No |
The number of minutes to retry after attempt fails. |
eventFilter |
String[] |
No |
Yes |
The events to capture. (See GetKnownEvents).
Supports custom events to be captured as well.
The new events will replace the previous events.
If nothing is passed in the callbacks will be removed.
|
Returns the successfully updated callback as a Callback business object.
RemoveCallback
This method removes the callback and requires partner key credentials.
Callback RemoveCallback(APIContext context, Int32 callbackId);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
callbackId |
Integer |
No |
Yes |
The callback id. |
Returns the successfully removed callback as a Callback business object.
GetQueueItemList
This method retrieves the queue items and requires partner key credentials.
QueueItem[] GetQueueItemList(APIContext context, Int32? userId, QueueItemType? queueItemType, QueueItemSubType? subType, DateTime? beforeDate, DateTime? afterDate, Boolean isCompleted);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
userId |
Integer |
Yes |
No |
The user id who initiated the item. |
queueItemType |
QueueItemType |
Yes |
No |
The type of queue item. |
subType |
QueueItemSubType |
Yes |
No |
The sub type of the queue item. |
beforeDate |
DateTime |
Yes |
No |
The date to get the queue items of before. |
afterDate |
DateTime |
Yes |
No |
The date to get the queue items of after. |
isCompleted |
Boolean |
No |
Yes |
True if the queue items are processed. |
Returns the list of all the queue items as QueueItem business objects.
GetPackageList
This method retrieves the package list and requires partner key credentials.
Package[] GetPackageList (APIContext context);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
Returns the list of all the packages as Packages business objects.
IsDomainAvailable
This method checks if the account domain exists and requires partner key credentials.
Boolean IsDomainAvailable(APIContext context, String domain);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
domain |
String |
No |
Yes |
The account domain to validate if it exists. |
Returns true or false if the domain is valid.
GetServerSummary
This method checks if the account domain exists and requires partner key credentials.
Instance GetServerSummary (APIContext context);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
Returns the server summary information as Instance business object.
GetInstanceAdminList
This method retrieves the list of all the instance admins and requires partner key credentials.
InstanceAdmin[] GetInstanceAdminList(APIContext context);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
Returns the list of all the instance admins as Instance Admin business objects.
AddInstanceAdmin
This method adds the user as an instance admin and requires partner key credentials.
InstanceAdmin AddInstanceAdmin(APIContext context, String userName, Int32? userId, Int32 roleId);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
userName |
String |
No |
No |
The username of the user. |
userId |
Integer |
No |
No |
The user id of the user. One of these fields is required. If both are provided, userId takes precedence. |
roleId |
Integer |
No |
Yes |
The role of the user. Only Instance roles are valid. |
Returns the successfully created instance admin as InstanceAdmin business object.
UpdateInstanceAdmin
This method updates the instance admin and requires partner key credentials.
InstanceAdmin UpdateInstanceAdmin(APIContext context, String userName, Int32? userId, Int32 roleId);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
userName |
String |
No |
No |
The username of the user. |
userId |
Integer |
No |
No |
The user id of the user. One of these fields is required. If both are provided, userId takes precedence. |
roleId |
Integer |
No |
Yes |
The role of the user. Only Instance roles are valid. |
Returns the successfully updated instance admin as InstanceAdmin business object.
RemoveInstanceAdmin
This method removes the instance admin and requires partner key credentials.
InstanceAdmin RemoveInstanceAdmin(APIContext context, Int32 userId);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
userId |
Integer |
No |
Yes |
The userid of the instance admin. |
Returns the successfully removed instance admin as InstanceAdmin business object.
GetEmailHistoryList
This method gets a list of email history and requires partner key credentials.
EmailHistory[] GetEmailHistoryList(APIContext context, Int32 accountId, Int32? userId, Boolean? isCancelled, Datetime? beforeDate, Datetime? afterDate, String searchText);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
accountId |
Integer |
Yes |
No |
The account id. |
userId |
Integer |
Yes |
No |
The user id of the user. |
isCancelled |
Boolean |
Yes |
No |
|
beforeDate |
Datetime |
Yes |
No |
|
afterDate |
Datetime |
Yes |
No |
|
searchText |
String |
Yes |
No |
|
Returns a list of EmailHistory Business objects based upon the selection criteria.
GetUserLoginHistoryList
This method gets a list of user login history and requires partner key credentials.
UserLoginHistory[] GetUserLoginHistoryList(APIContext context, Int32? userId);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
userId |
Integer |
No |
Yes |
The user id of the user. |
Returns a list of UserLoginHistory Business objects based upon the userId.
ReleaseUserPasswordLock
This method releases the password lock on a particular user and requires partner key credentials.
UserLoginHistory[] GetUserLoginHistoryList(APIContext context, Int32? userId);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
userId |
Integer |
No |
Yes |
The user id of the user. |
Returns a single User Business object that has had their password lock successfully reset.
GetAssetProfile
This method retrieves the asset's profile.
Asset GetAssetProfile(APIContext context, Int32 assetId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
assetId |
Integer |
No |
Yes |
The asset id. |
Returns the asset profile as Asset business object.
AddProjectAsset
This method uploads the asset on the project level root folder or files from bytes.
Asset AddProjectAsset(APIContext context, String name, String fileName, Int32? folderId, Int32 projectId, Byte[] fileData, Boolean isReferenceFile, List <assetuploadparameter> uploadParameters);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
name |
String |
No |
Yes |
The name of the asset. |
fileName |
String |
No |
Yes |
The full name of the asset with extension. |
folderId |
Integer |
Yes |
No |
The project level folder id. If not supplied then root folder is chosen by default. |
projectId |
Integer |
No |
Yes |
The project id. |
fileData |
Byte[] |
No |
Yes |
The file data in bytes. |
isReferenceFile |
Boolean |
No |
Yes |
True if the file is a non-collaborative file. |
uploadParameters |
List |
Yes |
No |
The list of upload parameters. |
Returns the successfully uploaded project asset's information as Asset business object.
AddDeliverableAsset
This method uploads the asset on the deliverable level root folder or files from bytes.
Asset AddDeliverableAsset(APIContext context, String name, String fileName, Int32? folderId, Int32 deliverableId, Byte[] fileData, Boolean isReferenceFile, List <assetuploadparameter> uploadParameters);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
name |
String |
No |
Yes |
The name of the asset. |
fileName |
String |
No |
Yes |
The full name of the asset with extension. |
folderId |
Integer |
Yes |
No |
The deliverable level folder id. If not supplied then root folder is chosen by default. |
deliverableId |
Integer |
No |
Yes |
The deliverable id. |
fileData |
Byte[] |
No |
Yes |
The file data in bytes. |
isReferenceFile |
Boolean |
No |
Yes |
True if the file is a non-collaborative file. |
uploadParameters |
List |
Yes |
No |
The list of upload parameters. |
Returns the successfully uploaded deliverable asset's information as Asset business object.
AddVersionedAsset
This method version's an asset from bytes.
Asset AddVersionedAsset(APIContext context, Int32 previousAsset, String name, String fileName, Byte[] fileData, Boolean isReferenceFile, List <assetuploadparameter> uploadParameters);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
previousAsset |
Integer |
No |
Yes |
The ID of the asset that you wish to version. |
name |
String |
No |
Yes |
The name of the asset. |
fileName |
String |
No |
Yes |
The full name of the asset with extension. |
fileData |
Byte[] |
No |
Yes |
The file data in bytes. |
isReferenceFile |
Boolean |
No |
Yes |
True if the file is a non-collaborative file. If versioning an account asset, this is overridden to true. |
uploadParameters |
List |
Yes |
No |
The list of upload parameters. |
Returns the successfully uploaded versioned asset's information as Asset business object.
AddProjectAssetFromLocalUri
This method uploads the asset on the project level root folder or files from a local location and requires partner key credentials.
Asset AddProjectAssetFromLocalUri(APIContext context, String name, String fileName, Int32? folderId, Int32 projectId, String filePathWithExtension, Boolean isReferenceFile, List <assetuploadparameter> uploadParameters);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
name |
String |
No |
Yes |
The name of the asset. |
fileName |
String |
No |
Yes |
The full name of the asset with extension. |
folderId |
Integer |
Yes |
No |
The account level folder id. The asset cannot be placed on the account's root folder. |
projectId |
Integer |
No |
Yes |
The project id. |
filePathWithExtension |
String |
No |
Yes |
The full file path with extension. |
isReferenceFile |
Boolean |
No |
Yes |
True if the file is a non-collaborative file. |
uploadParameters |
List |
Yes |
No |
The list of upload parameters. |
Returns the successfully uploaded project asset's information as Asset business object.
AddDeliverableAssetFromLocalUri
This method uploads the asset on the deliverable level root folder or files from a local location and requires partner key credentials.
Asset AddDeliverableAssetFromLocalUri(APIContext context, String name, String fileName, Int32? folderId, Int32 deliverableId, String filePathWithExtension, Boolean isReferenceFile, List <assetuploadparameter> uploadParameters);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
name |
String |
No |
Yes |
The name of the asset. |
fileName |
String |
No |
Yes |
The full name of the asset with extension. |
folderId |
Integer |
Yes |
No |
The account level folder id. The asset cannot be placed on the account's root folder. |
deliverableId |
Integer |
No |
Yes |
The deliverable id. |
filePathWithExtension |
String |
No |
Yes |
The full file path with extension. |
isReferenceFile |
Boolean |
No |
Yes |
True if the file is a non-collaborative file. |
uploadParameters |
List |
Yes |
No |
The list of upload parameters. |
Returns the successfully uploaded deliverable asset's information as Asset business object.
AddVersionedAssetFromLocalUri
This method version's an asset from a local location and requires partner key credentials.
Asset AddVersionedAssetFromLocalUri(APIContext context, Int32 previousAsset, String name, String fileName, String filePathWithExtension, Boolean isReferenceFile, List <assetuploadparameter> uploadParameters);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
previousAsset |
Integer |
No |
Yes |
The ID of the asset that you wish to version. |
name |
String |
No |
Yes |
The name of the asset. |
fileName |
String |
No |
Yes |
The full name of the asset with extension. |
filePathWithExtension |
String |
No |
Yes |
The full file path with extension. |
isReferenceFile |
Boolean |
No |
Yes |
True if the file is a non-collaborative file. If versioning an account asset, this is overridden to true. |
uploadParameters |
List |
Yes |
No |
The list of upload parameters. |
Returns the successfully uploaded versioned asset's information as Asset business object.
AddProjectAssetFromWebContent
This method adds a new WebContent asset to a project.
Asset AddProjectAssetFromWebContent(APIContext context, String name, Int32? folderId, Int32 projectId, String url, List<AssetUploadParameter> uploadParameters);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
name |
String |
No |
Yes |
The name of the asset. |
folderId |
Integer |
Yes |
No |
The project folder id. The asset cannot be placed on the account's root folder. |
projectId |
Integer |
No |
Yes |
The id of the project where this WebContent asset will be added. |
url |
String |
No |
Yes |
The url to use for the WebContent asset. |
uploadParameters |
List |
Yes |
No |
The list of upload parameters. |
Returns the uploaded project asset's information as Asset business object.
AddDeliverableAssetFromWebContent
This method adds a new WebContent asset to a deliverable.
Asset AddDeliverableAssetFromWebContent(APIContext context, String name, Int32? folderId, Int32 deliverableId, String url, List<AssetUploadParameter> uploadParameters);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
name |
String |
No |
Yes |
The name of the asset. |
folderId |
Integer |
Yes |
No |
The project folder id. The asset cannot be placed on the account's root folder. |
deliverableId |
Integer |
No |
Yes |
The id of the deliverable where this WebContent asset will be added. |
url |
String |
No |
Yes |
The url to use for the WebContent asset. |
uploadParameters |
List |
Yes |
No |
The list of upload parameters. |
Returns the uploaded project asset's information as Asset business object.
AddProjectAssetFromExternalUri
This method imports an external asset from a third-party URL to the project level root folder or sub-folder. It requires Partner API authorization.
WARNING: The file extension MUST match that of the Content-Type of the URI.
Asset AddProjectAssetFromExternalUri (APIContext context, String name, String fileName, Int32? folderId, Int32 projectId, string url, Boolean isReferenceFile, List <assetuploadparameter> uploadParameters);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
name |
String |
No |
Yes |
The name of the asset. |
fileName |
String |
No |
Yes |
The full name of the asset with extension. |
folderId |
Integer |
Yes |
No |
The account level folder id. The asset cannot be placed on the account's root folder. |
projectId |
Integer |
No |
Yes |
The project id. |
url |
String |
No |
Yes |
The url of the asset to be imported. NOTE: Must be URL Encoded. |
isReferenceFile |
Boolean |
No |
Yes |
True if the file is a non-collaborative file. |
uploadParameters |
List |
Yes |
No |
The list of upload parameters. |
Returns the successfully uploaded project asset's information as Asset business object.
AddDeliverableAssetFromExternalUri
This method imports an external asset from a third-party URL to the deliverable level root folder or sub-folder. Requires Partner API authorization.
WARNING: The file extension MUST match that of the Content-Type of the URI.
Asset AddDeliverableAssetFromExternalUri (APIContext context, String name, String extension, Int32? folderId, Int32 deliverableId, string url, Boolean isReferenceFile, List <assetuploadparameter> uploadParameters);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
name |
String |
No |
Yes |
The name of the asset. |
extension |
String |
Yes |
Yes |
Extension of the file being uploaded. |
folderId |
Integer |
Yes |
No |
The account level folder id. The asset cannot be placed on the account's root folder. |
deliverableId |
Integer |
No |
Yes |
The deliverable id. |
url |
String |
No |
Yes |
The url of the asset to be imported. NOTE: Must be URL Encoded. |
isReferenceFile |
Boolean |
No |
Yes |
True if the file is a non-collaborative file. |
uploadParameters |
List |
Yes |
No |
The list of upload parameters. |
Returns the successfully uploaded deliverable asset's information as Asset business object.
AddVersionedAssetFromExternalUri
This method version's an existing asset by importing an external asset from a third-party URL. Requires Partner API authorization.
WARNING: The file extension MUST match that of the Content-Type of the URI.
Asset AddVersionedAssetFromExternalUri(APIContext context, Int32 previousAsset, String name, String extension, string url, Boolean isReferenceFile, List <assetuploadparameter> uploadParameters);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
previousAsset |
Integer |
No |
Yes |
The ID of the asset that you wish to version. |
name |
String |
No |
Yes |
The name of the asset. |
extension |
String |
Yes |
Yes |
Extension of the file being uploaded. |
url |
String |
No |
Yes |
The url of the asset to be imported. NOTE: Must be URL Encoded. |
isReferenceFile |
Boolean |
No |
Yes |
True if the file is a non-collaborative file. If versioning an account asset, this is overridden to true. |
uploadParameters |
List |
Yes |
No |
The list of upload parameters. |
Returns the successfully uploaded versioned asset's information as Asset business object.
UploadTemporaryFile
Upload a file to a temporary folder in Conceptshare.
NOTE: By default, temporary assets that are more than 24 hours old are purged daily. Also note that the purge interval can be configured by your instance administrator.
String UploadTemporaryFile(APIContext context, Byte[] fileData)
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
fileData |
Byte[] |
No |
Yes |
The file data in bytes. |
Returns the temporary file's Id.
AddAssetsFromTemporaryFiles
List
AddAssetsFromTemporaryFiles(APIContext context, List assets, int projectId)
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
assets |
List |
No |
Yes |
A list of UploadAssets. See Business Objects definition for parameters.
|
projectId |
int |
No |
Yes |
The project id of the project the assets are being added to. |
Returns a list of the successfully uploaded versioned asset's information as Asset business object.
AddVersionedAssetFromTemporaryFile
Version an already existing asset with an asset that was just uploaded via
UploadTemporaryFile.
Asset AddVersionedAssetFromTemporaryFile(APIContext context, int previousAsset, string name, string fileName, string tmpFileId, bool isReferenceFile, List
uploadParameters)
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
previousAsset |
Integer |
No |
Yes |
The ID of the asset that you wish to version. |
name |
String |
No |
Yes |
The name of the asset. |
fileName |
String |
No |
Yes |
The full name of the asset with extension. |
tmpFileId |
String |
No |
Yes |
The GUID of the temporary file you wish to use to version the old asset with. |
isReferenceFile |
Boolean |
No |
Yes |
True if the file is a non-collaborative file. |
uploadParameters |
List |
Yes |
No |
The list of upload parameters. |
Returns the successfully uploaded versioned asset's information as Asset business object.
AddProjectAssetFromTemporaryFile
Asset AddProjectAssetFromTemporaryFile(APIContext context, string name, string fileName, int? folderId, int projectId, string tmpFileId, bool isReferenceFile, List
uploadParameters)
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
name |
String |
No |
Yes |
The name of the asset. |
fileName |
String |
No |
Yes |
The full name of the asset with extension. |
folderId |
Integer |
Yes |
No |
The account level folder id. The asset cannot be placed on the account's root folder. |
projectId |
Integer |
No |
Yes |
The project id. |
tmpFileId |
String |
No |
Yes |
The GUID of the temporary file you wish to use to version the old asset with. |
isReferenceFile |
Boolean |
No |
Yes |
True if the file is a non-collaborative file. |
uploadParameters |
List |
Yes |
No |
The list of upload parameters. |
Returns the successfully uploaded versioned asset's information as Asset business object.
AddDeliverableAssetFromTemporaryFile
Add an asset that was just uploaded via
UploadTemporaryFile to the deliverable level root folder or sub-folder.
Asset AddDeliverableAssetFromTemporaryFile(APIContext context, string name, string fileName, int? folderId, int deliverableId, string tmpFileId, bool isReferenceFile, List
uploadParameters)
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
name |
String |
No |
Yes |
The name of the asset. |
fileName |
String |
No |
Yes |
The full name of the asset with extension. |
folderId |
Integer |
Yes |
No |
The account level folder id. The asset cannot be placed on the account's root folder. |
deliverableId |
Integer |
No |
Yes |
The deliverable id. |
tmpFileId |
String |
No |
Yes |
The GUID of the temporary file you wish to use to version the old asset with. |
isReferenceFile |
Boolean |
No |
Yes |
True if the file is a non-collaborative file. |
uploadParameters |
List |
Yes |
No |
The list of upload parameters. |
Returns the successfully uploaded versioned asset's information as Asset business object.
CopyAsset
This method will replicate an asset and optionally include the comments to a folder within the same account.
Asset CopyAsset(APIContext context, Int32 assetId, String newAssetName, Int32? targetFolderId, Boolean includeFeedback);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
assetId |
Integer |
Yes |
Yes |
The asset id to create a copy for. |
newAssetName |
String |
Yes |
No |
The new name of the asset, if null, the original is used. |
targetFolderId |
Integer |
Yes |
No |
The project level folder id. If not supplied then root folder is chosen by default. |
includeFeedback |
Boolean |
No |
Yes |
A flag to determine if feedback (comments) should be copied including related markup. |
Returns the successfully copied asset's information as Asset business object.
RenameAsset
This method renames the asset.
Asset RenameAsset(APIContext context, Int32 assetId, String name);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
assetId |
Integer |
No |
Yes |
The asset id. |
name |
String |
No |
Yes |
The new name of the asset. |
Returns the successfully renamed asset as Asset business object.
MoveAsset
This method moves the asset.
Asset MoveAsset(APIContext context, Int32 assetId, Int32 folderId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
assetId |
Integer |
No |
Yes |
The asset id. |
folderId |
Integer |
No |
Yes |
The folder id where the asset is to be moved. |
Returns the successfully moved asset as Asset business object.
UpdateAsset
This method updates the asset's information.
Asset UpdateAsset(APIContext context, Int32 assetId, Int32? statusId, Boolean? isLocked, String description, String[] tagList);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
assetId |
Integer |
No |
Yes |
The asset id. |
statusId |
Integer |
Yes |
No |
Status of the asset. Only asset statuses are valid. To remove the value assigned -1 needs to be passed in. |
isLocked |
Boolean |
Yes |
No |
True stricts commenting on the asset. |
description |
String |
Yes |
No |
The description of the asset. |
tagList |
String[] |
Yes |
No |
The tags for the asset. The new tags will replace the previous tags. |
Returns the successfully updated asset as Asset business object.
RemoveAsset
This method removes the asset.
Asset RemoveAsset(APIContext context, Int32 assetId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
assetId |
Integer |
No |
Yes |
The asset id. |
Returns the successfully removed asset as Asset business object.
DownloadAsset
This method downloads an asset in bytes and requires partner key credentials.
Byte[] DownloadAsset(APIContext context, Int32 assetId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
assetId |
Integer |
No |
Yes |
The asset id. |
Returns the file in bytes.
DownloadAssetToLocalUri
This method downloads an asset to a local location and requires partner key credentials.
Boolean DownloadAssetToLocalUri(APIContext context, Int32 assetId, String outputFilePathWithExtension);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
assetId |
String |
No |
Yes |
The asset id. |
outputFilePathWithExtension |
String |
No |
Yes |
The full path with filename and extension. |
Returns true if download was successful.
DownloadAssetImage
This method downloads the asset image in bytes (as a JPG image).
Byte[] DownloadAssetImage(APIContext context, Int32 assetId, Int32? width, Int32? height);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
assetId |
String |
No |
Yes |
The asset id of the asset. |
width |
String |
No |
No |
The width of the asset. |
height |
String |
No |
No |
The height of the asset. |
Returns the image file in bytes.
DownloadAssetImageToLocalUri
This method downloads the asset image (as a jpg) to a local location and requires partner key credentials.
Boolean DownloadAssetImageToLocalUri(APIContext context, Int32 assetId, Int32? width, Int32? height, String outputFilePathWithExtension);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
assetId |
String |
No |
Yes |
The asset id of the asset. |
width |
String |
No |
No |
The width of the asset. |
height |
String |
No |
No |
The height of the asset. |
outputFilePathWithExtension |
String |
No |
Yes |
The full path with filename and extension. |
Returns true if download was successful.
DownloadMarkupImage
This method downloads the asset with the markup information related to the comment in bytes and requires partner key credentials.
Byte[] DownloadMarkupImage(APIContext context, Int32 commentId, Int32? width, Int32? height);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
commentId |
String |
No |
Yes |
The comment id of the asset. |
width |
String |
No |
No |
The width of the asset. |
height |
String |
No |
No |
The height of the asset. |
Returns the file in bytes.
DownloadMarkupImageToLocalUri
This method downloads the asset with the markup information related to the comment to a local location and requires partner key credentials.
Boolean DownloadMarkupImageToLocalUri(APIContext context, Int32 commentId, Int32? width, Int32? height, String outputFilePathWithExtension);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
commentId |
String |
No |
Yes |
The comment id of the asset. |
width |
String |
No |
No |
The width of the asset. |
height |
String |
No |
No |
The height of the asset. |
outputFilePathWithExtension |
String |
No |
Yes |
The full path with filename and extension. |
Returns true if download was successful.
This method set the flag for the specified comment.
void SetCommentFlag(APIContext context, int commentId, int flagId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
commentId |
Integer |
No |
Yes |
The comment id. |
flagId |
Integer |
No |
Yes |
The flag id. See GetFlagList for a list of valid flags for the account. |
N/A
This method removes the flag for the specified comment.
void RemoveCommentFlag(APIContext context, int commentId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
commentId |
Integer |
No |
Yes |
The comment id. |
N/A
This method set the flag resolution for the specified comment.
void SetCommentFlagResolution(APIContext context, int commentId, int resolutionId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
commentId |
Integer |
No |
Yes |
The comment id. |
resolutionId |
Integer |
No |
Yes |
The flag resolution id. See GetFlagResolutionList for a list of valid flag resolutions for the account. |
N/A
This method removes the flag resolution for the specified comment.
void RemoveCommentFlagResolution(APIContext context, int commentId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
commentId |
Integer |
No |
Yes |
The comment id. |
N/A
This method retrieves the list of comments.
Comment[] GetCommentList(APIContext context, Int32 assetId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
assetId |
Integer |
No |
Yes |
The asset id. |
reviewId |
Integer |
Yes |
No |
The review Id. |
Returns the list of comments as Comment business object. If a review Id is provided then only comments associated with that asset within the confines of the review.
This method retrieves the comment and its replies.
CommentThread[] SelectCommentThread(APIContext context, Int32 assetId, Int32 commentId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
assetId |
Integer |
No |
Yes |
The asset id. |
commentId |
Integer |
No |
Yes |
The comment id. |
Returns the list with the comment with its replies as CommentThread business object.
This method retrieves the list of comments and their replies.
CommentThread[] SelectCommentThreadList(APIContext context, Int32 assetId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
assetId |
Integer |
No |
Yes |
The asset id. |
Returns the list of comments with their replies as CommentThread business object.
The method creates the comment reply for the comment.
CommentReply AddCommentReply(APIContext context, Int32 commentId, Boolean? isDraft, String comment);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
commentId |
Integer |
No |
Yes |
The comment id. |
isDraft |
Boolean |
Yes |
No |
True if the comment reply is a draft. |
comment |
String |
No |
Yes |
The comment reply. |
Returns the successfully created comment reply as CommentReply business object.
This method updates the comment reply for the comment.
CommentReply UpdateCommentReply(APIContext context, Int32 commentReplyId, Int32? commentId, Boolean? isDraft, String comment);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
commentReplyId |
Integer |
No |
Yes |
The comment reply id. |
commentId |
Integer |
Yes |
No |
The comment id. |
isDraft |
Boolean |
Yes |
No |
True if the comment reply is draft. |
comment |
String |
No |
Yes |
The comment. |
Returns the successfully updated comment reply as CommentReply business object.
This method removes the comment reply for the comment.
CommentReply RemoveCommentReply(APIContext context, Int32 commentReply);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
commentReply |
Integer |
No |
Yes |
The comment reply id. |
Returns the successfully removed comment reply as CommentReply business object.
GetCustomformProfile
This method retrieves the CustomForm profile.
CustomForm GetCustomFormProfile(APIContext context, Int32 CustomFormId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
CustomFormId |
Integer |
No |
Yes |
The CustomForm id. |
Returns the CustomForm profile as CustomForm business object.
GetCustomFormList
The method retrieves the list of CustomForms.
CustomForm[] GetCustomFormList(APIContext context, CustomFormType? CustomFormType);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
CustomFormType |
CustomFormType |
Yes |
No |
The asset type, project type or comment type. |
Returns the list of CustomForms as CustomForm business objects.
AddCustomForm
This method creates the customform.
CustomForm AddCustomForm(APIContext context, CustomFormType CustomFormType, String name, String description, String code, Boolean? isDefault);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
CustomFormType |
CustomFormType |
No |
Yes |
The asset type, project type or comment type. |
name |
String |
No |
Yes |
The name of the customform. |
description |
String |
No |
Yes |
The description of the customform. |
code |
String |
No |
Yes |
The code of the customform. |
isDefault |
Boolean |
Yes |
No |
False if the customform is not default. |
Returns the successfully created CustomForm as CustomForm business object.
UpdateCustomForm
This method updates the customform.
CustomForm UpdateCustomForm(APIContext context, Int32 customFormId, String name, String description, String code, Boolean? isDefault);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
customFormId |
Integer |
No |
Yes |
The customform id. |
name |
String |
No |
Yes |
The name of the customform. |
description |
String |
Yes |
No |
The description of the customform. |
code |
String |
Yes |
No |
The code of the customform. |
isDefault |
Boolean |
Yes |
No |
False if the customform is not default. |
Returns the successfully updated CustomForm as CustomForm business object.
RemoveCustomForm
This method removes the customform.
CustomForm RemoveCustomForm(APIContext context, Int32 customFormId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
customFormId |
Integer |
No |
Yes |
The customform id. |
Returns the successfully removed CustomForm as a CustomForm business object.
GetCustomFieldProfile
This method retrieves the CustomField profile.
CustomField GetCustomFieldProfile(APIContext context, Int32 CustomFieldId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
CustomFieldId |
Integer |
No |
Yes |
The CustomField id. |
Returns the CustomField component as CustomField business object.
GetCustomFieldList
The method retrieves the list of CustomField components.
CustomField[] GetCustomFieldList(APIContext context, Int32 CustomFormId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
CustomFormId |
Integer |
No |
Yes |
The CustomForm id. | q
Returns the list of CustomField as CustomField business objects.
AddUpdateCustomFieldTextBox
The method creates and updates the CustomField textbox component.
CustomField AddUpdateCustomFieldTextBox(APIContext context, Int32? customFieldId, Int32? CustomFormId, Boolean? isRequired, Int32? orderId, String code, String label, String subLabel, String defaultValue, Boolean isMultiline, Int32 visibleLines, String watermarkText);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
customFieldId |
Integer |
Yes(on update) |
No(on create) |
The type of textbox component. |
CustomFormId |
Integer |
Yes(on update) |
Yes(on create) |
The CustomForm id. |
isRequired |
Boolean |
Yes(on update) |
Yes(on create) |
True if the the component is required field. |
orderId |
Integer |
Yes(on update) |
Yes(on create) |
The order id of the component. |
code |
String |
Yes(on update) |
Yes(on create) |
The code for the component. |
label |
String |
Yes(on update) |
Yes(on create) |
The label for the component. |
subLabel |
String |
Yes |
No |
The description for the label. |
defaultValue |
String |
Yes |
No |
The default value for the text box. |
isMultiline |
Boolean |
No |
Yes |
True if the textbox is multiline. |
visibleLines |
Integer |
No |
Yes |
The number of lines to display. |
watermarkText |
String |
No |
Yes |
The text to display as the watermark. If null the text will be removed. |
Returns the successfully created or updated CustomField as CustomField business objects.
AddUpdateCustomFieldList
The method creates and updates the CustomField list component.
CustomField AddUpdateCustomFieldList(APIContext context, Int32? customFieldId, Int32? CustomFormId, Boolean? isRequired, Int32? orderId, String code, String label, String subLabel, String defaultValue, Boolean isMultiSelect, Int32 visibleLines, ListDisplayType displayType, String[] items, String[] values);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
customFieldId |
Integer |
Yes(on update) |
No(on create) |
The type of textbox component. |
CustomFormId |
Integer |
Yes(on update) |
Yes(on create) |
The CustomForm id. |
isRequired |
Boolean |
Yes(on update) |
Yes(on create) |
True if the the component is required field. |
orderId |
Integer |
Yes(on update) |
Yes(on create) |
The order id of the component. |
code |
String |
Yes(on update) |
Yes(on create) |
The code for the component. |
label |
String |
Yes(on update) |
Yes(on create) |
The label for the component. |
subLabel |
String |
Yes |
No |
The description for the label. |
defaultValue |
String |
Yes |
No |
The default value for the text box. |
isMultiSelect |
Boolean |
No |
Yes |
True if the list is multi selectable. |
visibleLines |
Integer |
No |
Yes |
The number of lines to display. |
displayType |
ListDisplayType |
No |
Yes |
The type of list box. |
items |
String[] |
No |
Yes |
The item names inside the list box. If null the items will be removed. The new items will replace the previous items. |
values |
String[] |
No |
Yes |
The item values inside the list box. If null the values will be removed. The new values will replace the previous values. |
Returns the successfully created or updated CustomField as CustomField business object.
AddUpdateCustomFieldDateTime
The method creates and updates the CustomField datetime.
CustomFormComponent AddUpdateCustomFieldDateTime(APIContext context, Int32? customFieldId, Int32? CustomFormId, Boolean? isRequired, Int32? orderId, String code, String label, String subLabel, String defaultValue, DateTimeDisplayType dateTimeDisplayType, DateFormat dateFormat, TimeFormat timeFormat);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
customFieldId |
Integer |
Yes(on update) |
No(on create) |
The type of textbox component. |
CustomFormId |
Integer |
Yes(on update) |
Yes(on create) |
The CustomForm id. |
isRequired |
Boolean |
Yes(on update) |
Yes(on create) |
True if the component is required field. |
orderId |
Integer |
Yes(on update) |
Yes(on create) |
The order id of the component. |
code |
String |
Yes(on update) |
Yes(on create) |
The code for the component. |
label |
String |
Yes(on update) |
Yes(on create) |
The label for the component. |
subLabel |
String |
Yes |
No |
The description for the label. |
defaultValue |
String |
Yes |
No |
The default value for the datetime box. |
dateTimeDisplayType |
DateTimeDisplayType |
No |
Yes |
They type for date and time display. |
dateFormat |
DateFormat |
No |
Yes |
The type of date format. |
timeFormat |
TimeFormat |
No |
Yes |
The type of the time format. |
Returns the successfully created or updated CustomField as CustomField business object.
RemoveCustomField
This method removes the CustomField.
CustomFormComponent RemoveCustomField (APIContext context, Int32 componentId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
customFieldId |
Integer |
No |
Yes |
The CustomField id. |
Returns the successfully removed CustomField as CustomField business object.
GetCustomFormListByProject
This method retrieves the list of CustomForm project applications.
CustomFormApplication[] GetCustomFormListByProject(APIContext context, Int32 projectId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
projectId |
Integer |
No |
Yes |
The project id. |
Returns the list of CustomForm project applications as CustomFormApplication business objects.
AddCustomFormToProject
This method creates the CustomForm project application.
CustomFormApplication AddCustomFormToProject(APIContext context, Int32 CustomFormId, Int32 projectId, Int32? orderId, Boolean? isEnabled);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
CustomFormId |
Integer |
No |
Yes |
The CustomForm id. |
projectId |
Integer |
No |
Yes |
The project id. |
orderId |
Integer |
Yes |
No |
The number for ordering the application. Reordering of existing applications is required if inserted in the middle. |
isEnabled |
Boolean |
Yes |
No |
True if the application is enabled. |
Returns the successfully created CustomForm project application as CustomFormApplication business object.
UpdateCustomFormToProject
This method updates the CustomForm project application.
CustomFormApplication UpdateCustomFormToProject(APIContext context, Int32 CustomFormApplicationId, Int32? CustomFormId, Int32? projectId, Int32? orderId, Boolean? isEnabled);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
CustomFieldEntryId |
Integer |
No |
Yes |
The CustomForm application id. |
CustomFormId |
Integer |
Yes |
No |
The CustomForm id. |
projectId |
Integer |
Yes |
No |
The project id. |
orderId |
Integer |
Yes |
No |
The number for ordering the application. Reordering of existing applications is required if inserted in the middle. |
isEnabled |
Boolean |
Yes |
No |
True if the application is enabled. |
Returns the successfully updated CustomForm project application as CustomFormApplication business object.
RemoveCustomFormToProject
This method removes the CustomForm project application.
CustomFormApplication RemoveCustomFormToProject(APIContext context, Int32 CustomFieldEntryId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
CustomFieldEntryId |
Integer |
No |
Yes |
The CustomFieldEntry id. |
Returns the successfully removed CustomForm project application as CustomFormApplication business object.
GetCustomFieldEntryList
This method retrieves the list of CustomFieldEntry entries.
CustomFieldEntry[] GetCustomFieldEntryList(APIContext context, Int32? referenceId, CustomFormType CustomFormType);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
referenceId |
Integer |
Yes |
No |
The asset id, project id or comment id. |
CustomFormType |
CustomFormType |
No |
Yes |
The asset type, project type or comment type. |
Returns the list of CustomFieldEntry as CustomFieldEntry business objects.
GetCustomFieldEntryListForReview
This method retrieves the list of CustomFieldEntry entries for a review.
CustomFieldEntry[] GetCustomFieldEntryListForReview(APIContext context, Int32? reviewId, Int32 projectId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
reviewId |
Integer |
Yes |
No |
The review Id. |
projectId |
Integer |
No |
Yes |
The id of the project with the review. |
Returns the list of CustomFieldEntry as CustomFieldEntry business objects.
GetCustomFieldEntryListForAsset
This method retrieves the list of CustomFieldEntry entries for an asset.
CustomFieldEntry[] GetCustomFieldEntryListForAsset(APIContext context, Int32? assetId, Int32 projectId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
assetId |
Integer |
Yes |
No |
The asset Id. |
projectId |
Integer |
No |
Yes |
The id of the project with the asset. |
Returns the list of CustomFieldEntry as CustomFieldEntry business objects.
GetReviewCustomForms
This method retrieves the list of CustomFieldEntry entries.
ReviewCustomForms GetReviewCustomForms(APIContext context, Int32? reviewId, Int32 projectId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
reviewId |
Integer |
Yes |
No |
The review id. |
projectId |
CustomFormType |
No |
Yes |
The project id. |
Returns the ReviewCustomForms business object.
AddCustomFieldEntry
This method creates the CustomForm application entry.
CustomFieldEntry[] AddCustomFieldEntry(APIContext context, List <customfieldentry> data);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
data |
List <customfieldentry> |
No |
Yes |
The CustomFieldEntrys to create as bulk. |
Returns the successfully created CustomFieldEntry as CustomFieldEntry business object.
UpdateCustomFieldEntry
This method updates the CustomFieldEntry.
CustomFieldEntry[] UpdateCustomFieldEntry(APIContext context, List <customfieldentry> data);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
data |
List < customfieldentry > |
No |
Yes |
The CustomFieldEntrys to update as bulk. |
Returns the successfully updated CustomFieldEntry as CustomFieldEntry business object.
RemoveCustomFieldEntry
This method removes the CustomField entry.
CustomFieldEntry RemoveCustomFieldEntry(APIContext context, Int32 CustomFieldEntryId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
CustomFieldEntryId |
Integer |
No |
Yes |
The CustomField entry id. |
Returns the successfully removed CustomField entry as CustomField entry business object.
GetDeliverableProfile
This method retrieves the deliverable profile.
Deliverable[] GetDeliverableProfile(APIContext context, Int32 deliverableId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
deliverableId |
Integer |
No |
Yes |
The deliverable id. |
Returns the deliverable profile as Deliverable business object.
GetDeliverableList
This method retrieves the list of deliverables.
Deliverable[] GetDeliverableList(APIContext context, Int32 projectId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
projectId |
Integer |
No |
Yes |
The project id. |
Returns the list of deliverable's as Deliverable business objects.
AddDeliverable
This method creates the deliverable.
Deliverable AddDeliverable(APIContext context, Int32 projectId, Int32? userId, Int32? statusId, Int32? phaseId, Int32? phaseGroupId, Boolean? isViewedByAll, String name, String description, String code, DateTime? startDate, DateTime? endDate, String[] tagList);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
projectId |
Integer |
No |
Yes |
Project id to assign the deliverable under. |
userId |
Integer |
No |
Yes |
User id as the owner of the deliverable. |
statusId |
Integer |
Yes |
No |
Status of the deliverable. Only deliverable statuses are valid. |
phaseId |
Integer |
Yes |
No |
Phase of the deliverable. Only deliverable phases are valid. |
phaseGroupId |
Integer |
Yes |
No |
Phase Group if the deliverable phase. |
isViewedByAll |
Boolean |
Yes |
No |
True if allowed to be viewed by all project members. False if allowed to be viewed by specific members from the project members. Default is true. |
name |
String |
No |
Yes |
The name of the deliverable. |
description |
String |
Yes |
No |
The description of the deliverable. |
code |
String |
No |
Yes |
The code of the deliverable. |
startDate |
DateTime |
Yes |
No |
Start date of the deliverable in UTC. To remove the value assigned 1970-01-01 needs to be passed in. |
endDate |
DateTime |
Yes |
No |
End date of the deliverable in UTC. To remove the value assigned 1970-01-01 needs to be passed in. |
tagList |
String[] |
Yes |
No |
The tags for the deliverable. The new tags will replace the previous tags. |
Returns the successfully created deliverable as Deliverable business object.
UpdateDeliverable
This method updates the deliverable.
Deliverable UpdateDeliverable(APIContext context, Int32 deliverableId, Int32? userId, Int32? statusId, Int32? phaseId, Int32? phaseGroupId, Boolean? isViewedByAll, String name, String description, String code, DateTime? startDate, DateTime? endDate, String[] tagList);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
deliverableId |
Integer |
No |
Yes |
The deliverable id. |
userId |
Integer |
Yes |
No |
User id as the owner of the deliverable. |
statusId |
Integer |
Yes |
No |
Status of the deliverable. Only deliverable statuses are valid. |
phaseId |
Integer |
Yes |
No |
Phase of the deliverable. Only deliverable phases are valid. To remove the value assigned -1 needs to be passed in. |
phaseGroupdId |
Integer |
Yes |
No |
Phase Group if the deliverable phase. To remove the value assigned -1 needs to be passed in. |
isViewedByAll |
Boolean |
Yes |
No |
True if allowed to be viewed by all project members. False if allowed to be viewed by specific members from the project members. |
name |
String |
Yes |
No |
The name of the deliverable. |
description |
String |
Yes |
No |
The description of the deliverable. |
code |
String |
Yes |
No |
The code of the deliverable. |
startDate |
DateTime |
Yes |
No |
Start date of the deliverable in UTC. To remove the value assigned 1970-01-01 needs to be passed in. |
endDate |
DateTime |
Yes |
No |
End date of the deliverable in UTC. To remove the value assigned 1970-01-01 needs to be passed in. |
tagList |
String[] |
Yes |
No |
The tags for the deliverable. The new tags will replace the previous tags. |
Returns the successfully updated deliverable as Deliverable business object.
RemoveDeliverable
This method removes the deliverable.
Deliverable RemoveDeliverable(APIContext context, Int32 deliverableId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
deliverableId |
Integer |
No |
Yes |
The deliverable id. |
Returns the successfully removed deliverable as Deliverable business object.
GetDeliverableMemberList
This method retrieves the list of deliverable members.
DeliverableMember[] GetDeliverableMemberList(APIContext context, Int32 deliverableId, DeliverableMemberType? deliverableMemberType);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
deliverableId |
Integer |
No |
Yes |
The deliverable id. |
deliverableMemberType |
DeliverableMemberType |
Yes |
No |
The deliverable members of the following type are retrieved. |
Returns the list of deliverable members as DeliverableMember business objects.
AddTeamToDeliverable
This method adds the team to the deliverable.
DeliverableMember AddTeamToDeliverable(APIContext context, Int32 deliverableId, Int32 teamId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
deliverableId |
Integer |
No |
Yes |
The deliverable id. |
teamId |
Integer |
No |
Yes |
The team id. |
Returns the successfully created deliverable member as DeliverableMember business object.
RemoveTeamFromDeliverable
This method removes the team from the deliverable.
DeliverableMember RemoveTeamFromDeliverable(APIContext context, Int32 deliverableId, Int32 teamId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
deliverableId |
Integer |
No |
Yes |
The deliverable id. |
teamId |
Integer |
No |
Yes |
The team id. |
Returns the successfully removed deliverable member as DeliverableMember business object.
AddUserToDeliverable
This method adds the user to the deliverable.
DeliverableMember AddUserToDeliverable(APIContext context, Int32 deliverableId, Int32 userId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
deliverableId |
Integer |
No |
Yes |
The deliverable id. |
userId |
Integer |
No |
Yes |
The user id. |
Returns the successfully created deliverable member as DeliverableMember business object.
RemoveUserFromDeliverable
This method removes the user from the deliverable.
DeliverableMember RemoveUserFromDeliverable(APIContext context, Int32 deliverableId, Int32 userId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
deliverableId |
Integer |
No |
Yes |
The deliverable id. |
userId |
Integer |
No |
Yes |
The user id. |
Returns the successfully removed deliverable member as DeliverableMember business object.
GetFolderProfile
This method retrieves the folder's profile information.
Folder GetFolderProfile(APIContext context, Int32 folderId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
folderId |
Integer |
No |
Yes |
The folder id. |
Returns the folder's profile as Folder business object.
GetFolderMoveList
This method retrieves the list of folders inside the selected folder.
Folder[] GetFolderMoveList(APIContext context, Int32? folderId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
folderId |
Integer |
Yes |
No |
The folder id |
Returns the list of folder profiles as Folder business objects.
GetFolderItemList
This method retrieves the list of items inside the selected folder.
FolderItem[] GetFolderItemList(APIContext context, Int32 folderId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
folderId |
Integer |
No |
Yes |
The folder id. |
Returns the list of items inside the folder as FolderItem business objects.
GetFolderBreadcrumbs
This method returns the folder path for folder items to the specified folder.
FolderItem[] GetFolderBreadcrumbs(APIContext context, Int32 folderId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
folderId |
Integer |
No |
Yes |
The folder id. |
Returns the folder path to the specified folder as a list of Folder business objects.
AddFolder
This method creates the folder.
Folder AddFolder(APIContext context, Int32? parentFolderId, String name, String description);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
parentFolderId |
Integer |
Yes |
No |
The parent folder id. |
name |
String |
No |
Yes |
The name of the folder. |
description |
String |
No |
Yes |
The description of the folder. |
Returns the successfully created folder as Folder business object.
UpdateFolder
This method updates the folder.
Folder UpdateFolder(APIContext context, Int32 folderId, Int32? parentFolderId, String name, String description);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
folderId |
Integer |
No |
Yes |
The folder id. |
parentFolderId |
Integer |
Yes |
No |
The parent folder id. The folder will be moved if supplied and the folder is not at the previous location. |
name |
String |
Yes |
No |
The name of the folder. |
description |
String |
Yes |
No |
The description of the folder. |
Returns the successfully updated folder as Folder business object.
RemoveFolder
This method removes the folder.
Folder RemoveFolder(APIContext context, Int32 folderId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
folderId |
Integer |
No |
Yes |
The folder id. |
Returns the successfully removed folder as Folder business object.
GetFlag
This method retrieves the flag's profile.
Flag GetFlag(APIContext context, int flagId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
flagId |
Integer |
No |
Yes |
The flag id. |
Returns the flag profile as Flag business object.
GetFlagList
This method retrieves a list of flags on the given account.
List<Flag> GetFlagList(APIContext context);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
Returns the list of flags for a given account.
AddFlag
This method adds a new flag on the account.
Flag AddFlag(APIContext context, string name, string color);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
name |
String |
No |
Yes |
The name of the flag. |
color |
String |
No |
Yes |
The color of the flag in hex format (i.e. &FF00FF). |
Returns the flag profile as Flag business object.
UpdateFlag
This method updates an existing flag on the account.
Flag UpdateFlag(APIContext context, int flagId, string name, string color, bool isActive);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
flagId |
Integer |
No |
Yes |
The id of the flag to update. |
name |
String |
Yes |
Yes |
The name of the flag, pass null to leave unchanged. |
color |
String |
Yes |
Yes |
The color of the flag in hex format (i.e. &FF00FF), pass null to leave unchanged. |
isActive |
Boolean |
Yes |
Yes |
Sets the flag as in-active for flags that are in-use. |
Returns the flag profile as Flag business object.
RemoveFlag
This method removes an existing flag from the account.
Flag RemoveFlag(APIContext context, int flagId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
flagId |
Integer |
No |
Yes |
The id of the flag to remove. |
Returns the flag profile as Flag business object.
GetFlag
This method retrieves the flag resolutions's profile.
FlagResolution GetFlagResolution(APIContext context, int resolutionId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
resolutionId |
Integer |
No |
Yes |
The flag resolution id. |
Returns the flag resolution profile as FlagResolution business object.
GetFlagResolutionList
This method retrieves a list of flag resolutions on the given account.
List<FlagResolution> GetFlagResolutionList(APIContext context);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
Returns the list of flag resolutions for a given account.
AddFlagResolution
This method adds a new flag resolution on the account.
FlagResolution AddFlagResolution(APIContext context, string name);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
name |
String |
No |
Yes |
The name of the flag resolution. |
Returns the flag resolution profile as FlagResolution business object.
UpdateFlagResolution
This method updates an existing flag resolution on the account.
FlagResolution UpdateFlagResolution(APIContext context, int resolutionId, string name, bool isActive);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
resolutionId |
Integer |
No |
Yes |
The id of the flag resolution to update. |
name |
String |
Yes |
Yes |
The name of the resolution, pass null to leave unchanged. |
isActive |
Boolean |
Yes |
Yes |
Sets the resolution as in-active for resolutions that are in-use. |
Returns the flag resolution profile as FlagResolution business object.
RemoveFlagResolution
This method removes an existing flag resolution from the account.
FlagResolution RemoveFlagResolution(APIContext context, int resolutionId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
resolutionId |
Integer |
No |
Yes |
The id of the flag resolution to remove. |
Returns the flag resolution profile as FlagResolution business object.
AddLocalization
This method creates new system localization and requires Partner API authorization.
Localization AddLocalization(APIContext context, LocalizationType type, String txtKey, String txtDefaultValue);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
type |
LocalizationType |
No |
Yes |
The localization type. |
txtKey |
String |
No |
Yes |
The key of the new system localization. |
txtDefaultValue |
String |
No |
Yes |
The value of the new system localization. |
Returns the successfully created system localization as Localization business object.
UpdateLocalization
This method updates the system localization and requires Partner API authorization.
Localization UpdateLocalization(APIContext context, Int32 localizationId, LocalizationType type, String txtKey, String txtDefaultValue);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
localizationId |
Integer |
No |
Yes |
The system localization id. |
txtKey |
String |
No |
Yes |
The key of the system localization. |
txtDefaultValue |
String |
No |
Yes |
The value of the system localization. |
Returns the successfully updated system localization as Localization business object.
RemoveLocalization
This method removes the system localization and requires Partner API authorization.
Localization RemoveLocalization(APIContext context, Int32 localizationId);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
localizationId |
Integer |
No |
Yes |
The system localization id. |
Returns the successfully removed system localization as Localization business object.
GetLocalizationEntryProfile
This method retrieves the localization entry profile with the overridden entry replaced and requires Partner API authorization.
LocalizationEntry GetLocalizationEntryProfile(APIContext context, Int32 languageId, Int32 localizationId);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
languageId |
Integer |
No |
Yes |
The language that is required. |
localizationId |
Integer |
No |
Yes |
The localization id. |
Returns the localization entry profile as LocalizationEntry business object.
GetLocalizationEntryList
This method retrieves the list of localization entries with the overridden entries replaced and requires Partner API authorization.
Localization[] GetLocalizationEntryList(APIContext context, LocalizationType type, Int32? language);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
type |
LocalizationType |
No |
Yes |
The type of localization that will be returned. |
languageId |
Integer |
Yes |
No |
The language of the localization. |
Returns the list of localization entries as LocalizationEntry business objects.
AddLocalizationEntry
This method creates the localization entry by language and requires Partner API authorization.
LocalizationEntry AddLocalizationEntry(APIContext context, Int32 localizationId, Int32 languageId, String value);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
localizationId |
Integer |
No |
Yes |
The system localization id that is to be recreated. |
languageId |
Integer |
No |
Yes |
The language id of the localization entry. |
value |
String |
No |
Yes |
The value of the localization entry. |
Returns the successfully created localization entry as LocalizationEntry business object.
UpdateLocalizationEntry
This method updates the localization entry and requires Partner API authorization.
LocalizationEntry UpdateLocalizationEntry(APIContext context, Int32 localizationId, Int32 languageId, String value);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
localizationId |
Integer |
No |
Yes |
The system localization id that is to be updated for the localization entry. |
languageId |
Integer |
No |
Yes |
The language id to of the localization entry. |
value |
String |
No |
Yes |
The value of the localization entry. |
Returns the successfully update localization entry as LocalizationEntry business object.
RemoveLocalizationEntry
This method removes the localization entry and requires Partner API authorization.
LocalizationEntry RemoveLocalizationEntry(APIContext context, Int32 localizationEntryId);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
localizationEntryId |
Integer |
No |
Yes |
The localization entry id. |
Returns the successfully removed localization entry as LocalizationEntry business object.
AddLocalizationOverride
This method creates the localization override entry for the localization entry records and requires Partner API authorization.
LocalizationOverride AddLocalizationOverride(APIContext context, Int32 localizationEntryId, String value);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
localizationEntryId |
Integer |
No |
Yes |
The localization entry id to override. |
value |
Integer |
No |
Yes |
The new value of the localization entry. |
Returns the successfully created localization override entry as LocalizationOverride business object.
UpdateLocalizationOverride
This method updates the localization override entry and requires Partner API authorization.
LocalizationOverride UpdateLocalizationOverride(APIContext context, Int32 localizationEntryId, String value);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
localizationEntryId |
Integer |
No |
Yes |
The localization entry id to override. |
value |
Integer |
No |
Yes |
The new value of the localization entry. |
Returns the successfully updated localization override entry as LocalizationOverride business object.
RemoveLocalizationOverride
This method removes the localization override entry and reverts back to the original localization entry and requires Partner API authorization.
LocalizationOverride RemoveLocalizationOverride(APIContext context, Int32 localizationOverrideId);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
localizationOverrideId |
Integer |
No |
Yes |
The localization override entry id. |
Returns the successfully created localization override entry as LocalizationOverride business object.
GetAccountOptions
This method retrieves all the account based options as an AccountOption business object.
AccountOption[] GetAccountOptions(APIContext context, Int32? intAccount, Int32? intOption);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
intAccount |
Integer |
Yes |
No |
The account id to filter account option results by. |
intOption |
Integer |
Yes |
No |
The option id to filter the account option results by. |
Returns the successfully created account options as an AccountOption business object.
GetProjectList
This method retrieves the list of all the projects.
Project[] GetProjectList(APIContext context);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
Returns the list of all the projects as Project business objects.
GetProjectProfile
This method retrieves the profile of the specified project.
Project GetProjectProfile(APIContext context, Int32 projectId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
projectId |
Integer |
No |
Yes |
The project id of the profile requested. |
Returns the project's profile as Project business object.
AddProject
This method creates the project.
Project AddProject(APIContext context, Int32? userid, Int32? statusId, Int32? phaseId, Int32? phaseGroupId, DateTime? startDate, DateTime? endDate, String name, String description, String[] tagList, Int32? workflowTemplateId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
userId |
Integer |
No |
No |
User id as owner of the project. |
statusId |
Integer |
Yes |
No |
Status of the project. Only project statuses are valid. |
phaseId |
Integer |
Yes |
No |
Phase of the project. Only project phases are valid. |
phaseGroupId |
Integer |
Yes |
No |
Phase Group of the project phase. |
startDate |
DateTime |
Yes |
No |
Start date of the project in UTC. |
endDate |
DateTime |
Yes |
No |
End date of the project in UTC. |
name |
String |
No |
Yes |
The name of the project. |
description |
String |
Yes |
No |
The description of the project. |
tagList |
String[] |
Yes |
No |
The tags for the project. The new tags will replace the previous tags. |
workflowTemplateId |
Int32 |
Yes |
No |
The workflow template id associated with this project. |
Returns the successfully created project as Project business object.
UpdateProject
This method updates the project.
Project UpdateProject(APIContext context, Int32 projectId, Int32? userid, Int32? statusId, Int32? phaseId, Int32? phaseGroupId, DateTime? startDate, DateTime? endDate, String name, String description, String[] tagList);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
projectId |
Integer |
No |
Yes |
The project id. |
userId |
Integer |
Yes |
No |
User id as owner of the project. |
statusId |
Integer |
Yes |
No |
Status of the project. Only project statuses are valid. To remove the value assigned -1 needs to be passed in. |
phaseId |
Integer |
Yes |
No |
Phase of the project. Only project phases are valid.
To remove the value assigned -1 needs to be passed in.
|
phaseGroupId |
Integer |
Yes |
No |
Phase Group of the project phase.
To remove the value assigned -1 needs to be passed in.
|
>
startDate |
DateTime |
Yes |
No |
Start date of the project in UTC. |
endDate |
DateTime |
Yes |
No |
End date of the project in UTC. |
name |
String |
Yes |
No |
The name of the project. |
description |
String |
Yes |
No |
The description of the project. |
tagList |
String[] |
Yes |
No |
The tags for the project. The new tags will replace the previous tags. |
Returns the successfully updated project as Project business object.
RemoveProject
This method removes the project.
Project RemoveProject(APIContext context, Int32 projectId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
projectId |
Integer |
No |
Yes |
The project id. |
Returns the successfully removed project as Project business object.
GetProjectMemberList
This method retrieves the list of project members.
ProjectMember[] GetProjectMemberList(APIContext context, Int32 projectId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
projectId |
Integer |
No |
Yes |
The project id to retrieve the member list for. |
Returns the project members of the project as ProjectMember business objects.
AddUpdateProjectMember
This method creates or updates the project member. If the project member exists in the system the update procedure is called. If the project member doesn't exists the create procedure is called.
ProjectMember AddUpdateProjectMember(APIContext context, Int32 projectId, Int32 referenceId, ReferenceType referenceType, Int32? roleId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
projectId |
Integer |
No |
Yes |
The project id. |
referenceId |
Integer |
No |
Yes |
The user id or the team id. |
referenceType |
ReferenceType |
No |
Yes |
The user type or the team type. |
roleId |
Integer |
Yes |
No |
The role assigned to the user or team. |
Returns the successfully created or updated project member as ProjectMember business object.
RemoveProjectMember
This method removes the project member from the project.
ProjectMember RemoveProjectMember(APIContext context, Int32 projectId, Int32 referenceId, ReferenceType referenceType);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
projectId |
Integer |
No |
Yes |
The project id. |
referenceId |
Integer |
No |
Yes |
The user if or the team id. |
referenceType |
ReferenceType |
No |
Yes |
The user type or the team type. |
Returns the successfully removed project member as ProjectMember business object.
GetProjectTemplateProfile
This method retrieves the profile of the specified project template.
ProjectTemplate GetProjectTemplateProfile(APIContext context, Int32 projectTemplateId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
projectTemplateId |
Integer |
No |
Yes |
The project template id of the profile requested. |
Returns the project template's profile as ProjectTemplate business object.
GetProjectTemplateList
This method retrieves the list of project templates.
ProjectTemplate[] GetProjectTemplateList(APIContext context);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
Returns the list of project templates as ProjectTemplate business objects.
AddProjectTemplate
This method creates the project template.
ProjectTemplate AddProjectTemplate(APIContext context, Int32 userId, Int32? phaseId, Int32? phaseGroupId, Int32? workflowTemplateId, String name, String description, String[] tagList);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
userId |
Integer |
No |
Yes |
The user id as the owner of the project. |
phaseId |
Integer |
Yes |
No |
The phase of the project template. Only project phases are valid. |
phaseGroupId |
Integer |
Yes |
No |
Phase Group of the project template phase. |
workflowTemplateId |
Integer |
Yes |
No |
The workflow template to use when a project is created from this project template. |
name |
String |
No |
Yes |
The name of the project. |
description |
String |
No |
No |
The description of the project. |
tagList |
String[] |
No |
No |
The tags for the project. The new tags will replace the previous tags. |
Returns the successfully created project template as ProjectTemplate business object.
UpdateProjectTemplate
This method updates the project template.
ProjectTemplate UpdateProjectTemplate(APIContext context, Int32 projectTemplateId, Int32? userId, Int32? phaseId, Int32? phaseGroupId, Int32? workflowTemplateId, String name, String description, String[] tagList);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
projectTemplateId |
Integer |
No |
Yes |
The project template id. |
userId |
Integer |
Yes |
No |
The user id as the owner of the project. |
phaseId |
Integer |
Yes |
No |
The phase of the project template. Only project phases are valid. To remove the value assigned -1 needs to be passed in. |
phaseGroupId |
Integer |
Yes |
No |
Phase Group of the project template phase. To remove the value assigned -1 needs to be passed in. |
workflowTemplateId |
Integer |
Yes |
No |
The workflow template to use when a project is created from this project template. To remove the value assigned -1 needs to be passed in. |
name |
String |
No |
Yes |
The name of the project. |
description |
String |
Yes |
No |
The description of the project. |
tagList |
String[] |
Yes |
No |
The tags for the project. The new tags will replace the previous tags. |
Returns the successfully updated project template as ProjectTemplate business object.
RemoveProjectTemplate
This method removes the project template.
ProjectTemplate RemoveProjectTemplate(APIContext context, Int32 projectTemplateId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
projectTemplateId |
Integer |
No |
Yes |
This project template id. |
Returns the successfully removed project template as ProjectTemplate business object.
ArchiveProject
This method will archive the project.
Project ArchiveProject(APIContext context, Int32 projectId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
projectId |
Integer |
No |
Yes |
The project id. |
Returns the successfully updated project as Project business object.
UnarchiveProject
This method will unarchive the project.
Project UnarchiveProject(APIContext context, Int32 projectId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
projectId |
Integer |
No |
Yes |
The project id. |
Returns the successfully updated project as Project business object.
GetReminderList
This method retrieves the list of reminders.
Reminder[] GetReminderList(APIContext context, Int32 referenceId, ReminderType referenceType);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
referenceId |
Integer |
No |
Yes |
The deliverable id, todo id or review id. |
referenceType |
ReminderType |
No |
Yes |
The reminder type of the reference id. |
Returns the list of reminders as Reminder business objects.
AddReminder
This method creates the reminder.
Reminder AddReminder(APIContext context, Int32 referenceId, Reminder referenceType, Int32 amount, AmountType amountType);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
referenceId |
Integer |
No |
Yes |
The deliverable id, todo id and review id. |
referenceType |
ReminderType |
No |
Yes |
The reminder type of the reference id. |
amount |
Integer |
No |
Yes |
The amount of time for the reminder. |
amountType |
AmountType |
No |
Yes |
The type of time of the reminder. |
Returns the successfully created reminder as Reminder business object.
UpdateReminder
This method updates the reminder.
Reminder UpdateReminder(APIContext context, Int32 reminderId, Int32? referenceId, ReminderType? referenceType, Int32? amount, AmountType? amountType);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
reminderId |
Integer |
No |
Yes |
The reminder id. |
referenceId |
Integer |
Yes |
No |
The deliverable id, todo id and review id. |
referenceType |
ReminderType |
Yes |
No |
The reminder type of the reference id. |
amount |
Integer |
Yes |
No |
The amount of time for the reminder. |
amountType |
AmountType |
Yes |
No |
The type of time of the reminder. |
Returns the successfully updated reminder as Reminder business object.
RemoveReminder
This method removes the reminder.
Reminder RemoveReminder(APIContext context, Int32 reminderId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
reminderId |
Integer |
No |
Yes |
The reminder id. |
Returns the successfully removed reminder as Reminder business object.
GenerateFeedbackSummary
This method generates the feedback summary file in bytes and requires partner key credentials.
Byte[] GenerateFeedbackSummary(APIContext context, FeedbackSummaryOptions options);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
options |
FeedbackSummaryOptions |
No |
Yes |
The options to generate the feedback summary. |
Returns the feedback summary in bytes.
GenerateFeedbackSummaryToLocalUri
This method generates and downloads the feedback summary to a local location and requires partner key credentials.
Boolean GenerateFeedbackSummaryToLocalUri(APIContext context, FeedbackSummaryOptions options, String outputFilePathWithExtension);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
options |
FeedbackSummaryOptions |
No |
Yes |
The options to generate the review summary. |
outputFilePathWithExtension |
String |
No |
Yes |
The full file path and file name with extension. |
Returns true if the feedback summary was successfully stored on/as the outputFilePathWithExtension.
GenerateArchiveProject
This method generates the archived project file in bytes and requires partner key credentials.
Byte[] GenerateArchiveProject(APIContext context, Int32 projectId, ArchiveProjectOptions options, FeedbackSummaryOptions feedbackSummaryOptions);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
projectId |
Integer |
No |
Yes |
The project id. |
options |
ArchiveProjectOptions |
No |
Yes |
The options to archive sections of the project. |
feedbackSummaryOptions |
FeedbackSummaryOptions |
No |
Yes |
The options to generate the feedback summary. |
Returns the archived project in bytes as a .zip document.
GenerateArchiveProjectToLocalUri
This method generates and downloads the archived project files to a local location and requires partner key credentials.
Boolean GenerateArchiveProjectToLocalUri(APIContext context, Int32 projectId, ArchiveProjectOptions options, FeedbackSummaryOptions feedbackSummaryOptions, String outputPath);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
projectId |
Integer |
No |
Yes |
The project id. |
options |
ArchiveProjectOptions |
No |
Yes |
The options to archive sections of the project. |
feedbackSummaryOptions |
FeedbackSummaryOptions |
No |
Yes |
The options to generate the feedback summary. |
outputPath |
String |
No |
Yes |
The output path where the archived documents will be stored.
OutputPath can take one of these formats:
Directory: To store all the archived documents.
Path With Filename and Extension: To store a single file.
If only the review summary options are required then the output path should include the file name and the extension.
|
Returns true if the achieve project was successfully stored to the output path.
GetAccountUserList
This method retrieves the list of all the account users.
AccountUser[] GetAccountUserList(APIContext context);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
Returns the list of account users as AccountUser business objects.
GetAccountUserProfile
This method retrieves the the account user profile for the specified user.
AccountUser GetAccountUserProfile(APIContext context, int userId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
userId |
Int32 |
No |
Yes |
The user id of the user profile you would like returned. |
Returns the account user profile as a AccountUser business object.
GetAccountUserProfileByEmail
This method retrieves the the account user profile for the specified email address.
AccountUser GetAccountUserProfileByEmail(APIContext context, string emailAddress);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
emailAddress |
string |
No |
Yes |
The email address (username) of the user profile you would like returned. |
Returns the account user profile as a AccountUser business object.
AddAccountUser
This method adds the existing user to the currently logged in account.
AccountUser AddAccountUser(APIContext context, Int32 userId, Int32 roleId, Int32 projectRoleId, Boolean isActive, Int32? reviewRoleId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
userId |
Integer |
No |
Yes |
The user id of the existing user. |
roleId |
Integer |
No |
Yes |
The role id for the user on this account. |
projectRoleId |
Integer |
No |
Yes |
The project role id for the user on this account. |
isActive |
Boolean |
No |
Yes |
True if the user is active. |
reviewRoleId |
Integer |
Yes |
No |
The default reviewer role. |
Returns the successfully created account user as AccountUser business object.
AddAccountUserNew
This method creates a new user and adds them to the currently logged in account.
AccountUser AddAccountUserNew(APIContext context, String userName, String firstName, String lastName, Int32? roleId, Int32? projectRoleId, Int32? languageId, Int32? timeZoneId, Int32? reviewRoleId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
userName |
String |
No |
Yes |
The email address for the user. |
firstName |
String |
No |
Yes |
The first name of the user. |
lastName |
String |
No |
Yes |
The last name of the user. |
roleId |
Integer |
Yes |
No |
The role id for the user on this account. |
projectRoleId |
Integer |
Yes |
No |
The project role id for the user on this account. |
languageId |
Integer |
Yes |
No |
The language assigned to the user. |
timeZoneId |
Integer |
Yes |
No |
The timezone assigned to the user. |
reviewRoleId |
Integer |
Yes |
No |
The default reviewer role. |
Returns the successfully created account user as AccountUser business object.
UpdateAccountUser
This method updates the user in the currently logged in account.
AccountUser UpdateAccountUser(APIContext context, Int32 userId, Int32? roleId, Int32? projectRoleId, Boolean? isActive, Int32? reviewRoleId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
userId |
Integer |
No |
Yes |
The user id of the existing user. |
roleId |
Integer |
Yes |
No |
The role id for the user on this account. |
projectRoleId |
Integer |
Yes |
No |
The project role id for the user on this account. |
isActive |
Boolean |
Yes |
No |
True if the user is active. |
reviewRoleId |
Integer |
Yes |
No |
The default reviewer role. |
Returns the successfully updated user as AccountUser business object.
ChangeAccountUserPassword
This method allows an account administrator to change another user's password. This will only succeed if the user is only part of a single account. In situations where you need to change the password of a user who is part of more then one account, use the UpdateUser API call.
Boolean ChangeAccountUserPassword(APIContext context, Int32 userId, String newPassword);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
userId |
Integer |
No |
Yes |
The user id of the existing user. |
newPassword |
String |
No |
Yes |
The new password to set for the user. |
Returns true if the password was successfully reset.
AcceptTermsAndConditions
This method accepts the terms and conditions for a given user. If the user specified is a different user from the caller then partner API context's are required.
Boolean AcceptTermsAndConditions(APIContext context, Int32 userId, Boolean markAsAccepted);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
userId |
Integer |
No |
Yes |
The user id of the existing user. |
markAsAccepted |
Boolean |
No |
Yes |
The flag to determine if the terms and conditions are accepted. |
Returns true if the terms and conditions were successfully accepted.
RegisterUser
This method registers a given user. This call is only necessary if you DO NOT have instance admin access but wish to add a user and set their registered flag to true. Typically, this flag is set when the user's password is set either through first login, or when set via API (either on creation or set explicitly after the fact). Please note that calling this function will not set a random password, but will simply short-circuit the flag.
Boolean RegisterUser(APIContext context, Int32 userId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
userId |
Integer |
No |
Yes |
The user id of the user to be registered. |
Returns true if the user is successfully registered.
RemoveAccountUser
This method removes the user from the currently logged in account.
AccountUser RemoveAccountUser(APIContext context, Int32 userId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
userId |
Integer |
No |
Yes |
The user id of the user. |
Returns the successfully removed user as AccountUser business object.
GetTeamList
This method retrieves the list of all the teams.
Team[] GetTeamList(APIContext context);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
Returns the list of teams as Team business object.
GetTeamProfile
This method retrieves a single team's profile.
TeamProfile GetTeamProfile(APIContext context, Int32 teamId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
teamId |
Int32 |
No |
Yes |
The team id of which the team profile to be returned |
Returns a TeamProfile business object.
GetUserTeamList
This method retrieves all the teams the user is associated with.
Team[] GetUserTeamList(APIContext context, Int32 userId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
userId |
Integer |
No |
Yes |
The user id of the user. |
Returns the teams associated to the user as Team business object.
AddTeam
This method creates a new team.
Team AddTeam(APIContext context, String name, String description, Int32 managerId, Boolean? workRequiresDelegation, Int32? projectRoleId, Int32? reviewRoleId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
name |
String |
No |
Yes |
The name of the team. |
description |
String |
Yes |
No |
The description of the team. |
managerId |
Integer |
No |
Yes |
The user id who will be assigned the manager role. |
workRequiresDelegation |
Boolean |
Yes |
No |
True if the team items must be reassigned by Managers only. False if the team items can be picked up by any members. |
projectRoleId |
Integer |
Yes |
No |
The default project role of the team. |
reviewRoleId |
Integer |
Yes |
Yes (if the feature is enabled) |
The default review role of the team. |
Returns the successfully created team as Team business object.
UpdateTeam
This method updates the team.
Team UpdateTeam(APIContext context, Int32 teamId, String name, String description, Int32? managerId, Boolean? workRequiresDelegation, Int32? projectRoleId, Int32? reviewRoleId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
teamId |
Integer |
No |
Yes |
The team id. |
name |
String |
Yes |
No |
The name of the team. |
description |
String |
Yes |
No |
The description of the team. |
managerId |
Integer |
Yes |
No |
The user id who will be assigned the manager role. |
workRequiresDelegation |
Boolean |
Yes |
No |
True if the team items must be reassigned by Managers only. False if the team items can be picked up by any members. |
projectRoleId |
Integer |
Yes |
No |
The default project role of the team. |
reviewRoleId |
Integer |
Yes |
No |
The default review role of the team. |
Returns the successfully updated team a Team business object.
RemoveTeam
This method removes the team.
Team RemoveTeam(APIContext context, Int32 teamId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
teamId |
Integer |
No |
Yes |
The team id. |
Returns the successfully removed team a Team business object.
GetTeamMemberList
This method retrieves the list of team members.
TeamMember[] GetTeamMemberList(APIContext context, Int32 teamId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
teamId |
Integer |
No |
Yes |
The team id. |
Returns the list of team members as TeamMember business object.
AddUpdateUserToTeam
This method creates or updates the user to the team.
TeamMember AddUpdateUserToTeam(APIContext context, Int32 teamId, Int32 userId, Boolean isTeamManager);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
teamId |
Integer |
No |
Yes |
The team id. |
userId |
Integer |
No |
Yes |
The user id of the user to add to the team. |
isTeamManager |
Boolean |
No |
Yes |
True if the user is a manager. |
Returns the successfully created or updated user to the team as TeamMember business object.
RemoveUserFromTeam
This method removes the user from the team.
TeamMember RemoveUserFromTeam(APIContext context, Int32 teamId, Int32 userId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
teamId |
Integer |
No |
Yes |
The team id of the team. |
userId |
Integer |
No |
Yes |
The user id of the user to remove from the team. |
Returns the successfully removed user from the team as TeamMember business object.
GetResourceUrl
This method retrieves the resource URL.
Resource Url Type |
Required ResourceUrlOptions Properties |
Base (For All ResourceUrlType's) |
SecureUrl, SingleUseOnly, PreAuthenticateUser, ExpiryDate |
Account |
Base |
Project |
Base, ProjectId |
Reference |
Base, ReferenceId, ReferenceType |
AssetDownloadUrl |
Base, ReferenceId, ReferenceType (Asset) |
AssetCompareUrl |
Base, ReferenceId, ReferenceType (Asset), SecondReferenceId, SecondReferenceType (Asset) |
ReviewDialog |
N/A - Use GetReviewDialogUrl endpoint |
ReviewAsset |
Base, ReferenceId, ReferenceType (Review), SecondReferenceId, SecondReferenceType (Asset) |
String GetResourceUrl(APIContext context, ResourceUrlOptions urlOptions);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
urlOptions |
ResourceUrlOptions |
No |
Yes |
The url options. |
Returns the resource URL.
Resource Url Type |
Required ResourceUrlOptions Properties |
Base (For All ResourceUrlType's) |
SecureUrl, SingleUseOnly, PreAuthenticateUser, ExpiryDate |
Account |
Base |
Project |
Base, ProjectId |
Reference |
Base, ReferenceId, ReferenceType |
AssetDownloadUrl |
Base, ReferenceId, ReferenceType (Asset) |
AssetCompareUrl |
Base, ReferenceId, ReferenceType (Asset), SecondReferenceId, SecondReferenceType (Asset) |
ReviewDialog |
N/A - Use GetReviewDialogUrl endpoint |
ReviewAsset |
Base, ReferenceId, ReferenceType (Review), SecondReferenceId, SecondReferenceType (Asset) |
GetResourceUrlForUser
This method retrieves the resource URL for another user and requires Partner API authorization.
String GetResourceUrlForUser(APIContext context, Int32 userId,ResourceUrlOptions urlOptions);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
userId |
Int32 |
No |
Yes |
The user id for whom the resource URL is being generated. |
urlOptions |
ResourceUrlOptions |
No |
Yes |
The url options |
Returns the resource URL for another user.
GetReviewProfile
This method retrieves the review profile.
Review GetReviewProfile(APIContext context, Int32 reviewId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
reviewId |
Integer |
No |
Yes |
The review id. |
Returns the review profile as Review business object.
GetReviewProfileFull
This method retrieves the complete review profile that includes the review, review items and review members.
ReviewData GetReviewProfileFull(APIContext context, Int32 reviewId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
reviewId |
Integer |
No |
Yes |
The review id. |
Returns the complete review profile as ReviewData business object.
GetReviewList
This method retrieves the list of reviews.
Review[] GetReviewList(APIContext context, Int32 projectId, Int32? deliverableId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
projectId |
Integer |
No |
Yes |
The project id to retrieve the reviews associated with the project. |
deliverableId |
Integer |
Yes |
No |
The deliverable id to retrieve the reviews associated with the deliverable. |
Returns the list of all the reviews as Review business objects.
GetReviewChain
This method retrieves the list of all reviews that are part of the specified review's chain.
ReviewDetailed[] GetReviewChain(APIContext context, Int32 reviewId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
reviewId |
Integer |
No |
Yes |
The review id to retrieve the review chain for. |
Returns the list of all the reviews as ReviewDetailed business objects.
GetReviewStatistics
The method will return various statistics about the review.
ReviewStatistics GetReviewStatistics(APIContext context, Int32 reviewId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
reviewId |
Integer |
No |
Yes |
The review id to retrieve the statistics for. |
Returns the review statistics for the specified review.
AddUpdateReviewFull DEPRECATED
This method creates or updates the complete review with the option to add in review members and review items.
NOTE: This endpoint will be replaced with
AddUpdateReview and will not be available in ConceptShare 7.0 and later versions
Review AddUpdateReviewFull(APIContext context, Int32? reviewId, Int32? projectId, Int32? referenceId, ReferenceType? referenceType, ReviewType reviewType, Int32? statusId, Int32? priority, AutoApproveMethod? autoApproveMethod, Boolean? isReviewCommentsOnly, Boolean? isAllowedFeedback, Boolean? isAllowedNotes, Boolean? isAllowedMembersToView, String title, String description, String code, String[] autoTags, DateTime? dueDate, List <reviewmember> arrMembers, List <reviewitem> arrItems, Boolean? requireResourceOnDeferral, Boolean? allowDeferralResponses, Boolean? bitElectronicSignatureRequired, List<ExternalReviewer> arrExternalReviewers, int? previousReviewId, StartRule? startRule);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
reviewId |
Integer |
Yes |
No |
The review id. |
projectId |
Integer |
Yes |
Yes(on create) |
The project id. |
referenceId |
Integer |
No |
Yes |
The deliverable or project id. |
referenceType |
ReferenceType |
No |
Yes |
The deliverable type or project type of reference id. |
reviewType |
ReviewType |
No |
Yes |
The type of review. |
statusId |
Integer |
Yes |
No |
The status id of the review. Only review statuses are valid. |
priority |
Integer |
Yes |
No |
The priority of the review. Normal Priority: 0 and High Priority: 1 |
autoApproveMethod |
AutoApproveMethod |
Yes |
No |
The option to turn on and off the auto approve. |
isReviewCommentsOnly |
Boolean |
Yes |
No |
Allows reviewing comments only. |
isAllowedFeedback |
Boolean |
Yes |
No |
Allows the capability to provide feedback. |
isAllowedNotes |
Boolean |
Yes |
No |
Allows the capability to leave comments. |
isAllowedMembersToView |
Boolean |
Yes |
No |
Allows the members to view comments. |
title |
String |
No |
Yes |
The title of the review. |
description |
String |
No |
Yes |
The instructions for the review. |
code |
String |
No |
Yes |
The code of the review. |
autoTags |
String[] |
No |
Yes |
The tags for the asset. |
dueDate |
DateTime |
Yes |
No |
The due date of the review in UTC. |
arrMembers |
List |
No |
No |
The members list of the review. See Review Member. |
arrItems |
List |
No |
No |
The items list of the review. See Review Item. |
requireResourceOnDeferral |
Boolean |
Yes |
No |
Reviewers are required to specify an alternative resource on deferral. |
allowDeferralResponses |
Boolean |
Yes |
No |
Allows review members to defer review responses. |
bitElectronicSignatureRequired |
Boolean |
Yes |
No |
Requires reviewers to sign with an electronic signature upon submitting responses. |
arrExternalReviewers |
List |
No |
No |
List of external reviewers. See ExternalReviewer in Business Objects. |
previousReviewId |
Integer |
Yes |
No |
The previous review to link this review to (for review chaining). |
startRule |
StartRule |
Yes |
No |
The start rule for the review. |
Returns the successfully created or update review as Review business object.
AddUpdateReview
This method creates or updates the complete review with the option to add in review members and review items.
ReviewDto AddUpdateReview(APIContext context, AddUpdateReviewDto review);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
review |
AddUpdateReviewDto |
No |
Yes |
The review to create/update. |
Parameter |
Data Type |
Nullable |
Required |
Description |
Id |
Integer |
Yes |
No |
Review id (specify if editing existing) |
Code |
String |
No |
Yes |
Review code Required on add. |
Title |
String |
No |
Yes |
Review title. Required on add. |
Instructions |
String |
Yes |
No |
The review instructions. |
ProjectId |
Integer |
Yes |
No |
The project id for this review. Required on add not on update. |
DeliverableId |
Integer |
Yes |
No |
The deliverable id for this review (if any). |
OwnerId |
Integer |
Yes |
No |
The owners user id. |
StatusId deprecated |
Integer |
Yes |
No |
The review status id. |
DueDate |
DateTime |
Yes |
No |
The due date (if any) |
AutoApproveMethod |
AutoApproveMethod |
Yes |
No |
The auto approval method |
AutoTags |
String |
Yes |
No |
The list of tags to be applied to an asset upon global approval. |
AllowFeedback |
Boolean |
Yes |
No |
Flag indicating whether to allow feedback on this review. |
AllowReviewersToDeferResponses |
Boolean |
Yes |
No |
Flag indicating whether to allow reviewers to defer responses. |
AllowDeferralToResources |
Boolean |
Yes |
No |
Flag indicating whether upon deferral if the reviewer must specify a resource to defer too. |
ElectronicSignatureRequired |
Boolean |
Yes |
No |
Flag indicating if electronic signatures should be enabled. NOTE: Requires the electronic signature module enabled. |
AutomaticallyAddMembersToProject |
Boolean |
No |
Yes |
Flag indicating if review members that are not part of the project should automatically be added to the project with their default project role. |
PreviousReviewId |
Integer |
Yes |
No |
The previous review to link this review to (for review chaining). |
StartRule |
StartRule |
Yes |
No |
The start rule for the review. |
Members |
List<AddUpdateReviewMemberDto> |
No |
Yes |
List of review members |
Items |
List<AddUpdateReviewItemDto> |
No |
Yes |
List of review items (assets) |
Parameter |
Data Type |
Nullable |
Required |
Description |
Email |
String |
Yes |
No |
The email address of the individual to invite (if external reviewer). |
First Name |
String |
Yes |
No |
The first name of the reviewer (if external reviewer). |
Last Name |
String |
Yes |
No |
The last name of the reviewer (if external reviewer). |
ReferenceId |
Integer |
Yes |
No |
The reference id of the resource to add. Required for known system users, teams and roles. |
ReferenceType |
ReferenceType |
Yes |
No |
The reference type of the resource to add. Required for system users, teams and roles. |
ReviewRoleId |
Integer |
Yes |
No |
The review role to assign the reviewer. |
IsExternalReviewer |
Boolean |
Yes |
No |
Flag indicating if this resource is an external reviewer. |
Parameter |
Data Type |
Nullable |
Required |
Description |
AssetId |
Integer |
No |
No |
The asset id |
Returns the successfully created or update review as ReviewDto business object.
SetReviewStatus
This method sets the status of a review.
void SetReviewStatus(APIContext context, int32 reviewId, int32 statusId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
reviewId |
Integer |
No |
Yes |
The review id. |
statusId |
Integer |
No |
Yes |
The new status id. |
N/A
RemoveReview
This method removes the review.
Review RemoveReview(APIContext context, Int32 reviewId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
reviewId |
Integer |
No |
Yes |
The review id. |
Returns the successfully removed review as Review business object.
GetReviewMemberList
This method retrieves the list of review members of the review.
ReviewMember[] GetReivewMemberList(APIContext context, Int32 reviewId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
reviewId |
Integer |
No |
Yes |
The review id. |
Returns the list of review members as ReviewMember business objects.
AddUpdateReviewMember
This method creates or updates the review member.
ReviewMember AddUpdateReviewMember(APIContext context, Int32 reviewId, Int32 referenceId, ReferenceType referenceType, Int32? statusId, String comments, DateTime? completionDate, Int32? reviewRoleId, Boolean? automaticallyAddMembersToProject);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
reviewId |
Integer |
No |
Yes |
The review id. |
referenceId |
Integer |
No |
Yes |
The user id, team id or role id. |
referenceType |
ReferenceType |
No |
Yes |
The user type, team type or role type of reference id. |
statusId |
Integer |
Yes |
No |
Status of the review. Only review statuses are valid. |
comments |
String |
No |
No |
The comment for the review. |
completionDate |
DateTime |
Yes |
No |
Date the member completed the review in UTC. |
reviewRoleId |
Integer |
Yes |
No |
Review role id of the new review member. |
automaticallyAddMembersToProject |
Boolean |
Yes |
Yes (if review role module is enabled) |
Flag indicating if review members that are not part of the project should automatically be added to the project with their default project role. |
Returns the successfully created or updated review member as ReviewMember business object.
AddUpdateExternalReviewer
This method creates or updates the review external member.
ReviewMember AddUpdateExternalReviewer(APIContext context, Int32 reviewId, String email, String firstName, String lastName, Int32? reviewRoleId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
reviewId |
Integer |
No |
Yes |
The review id. |
email |
String |
No |
Yes |
The email address of the user. |
firstName |
String |
No |
Yes |
The first name of the user. |
lastName |
String |
No |
Yes |
The last name of the user. |
reviewRoleId |
Integer |
Yes |
Yes (if the feature is enabled) |
Review role id of the new review external member. |
Returns the successfully created or updated review external member as ReviewMember business object.
RemoveReviewMember
This method removes the review member of the review.
ReviewMember RemoveReviewMember(APIContext context, Int32 reviewId, Int32 referenceId, ReferenceType referenceType);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
reviewId |
Integer |
No |
Yes |
The review id. |
referenceId |
Integer |
No |
Yes |
The user type, team type or role id. |
referenceType |
ReferenceType |
No |
Yes |
The user type, team type or role type of reference id. |
Returns the successfully removed review member as ReviewMember business object.
GetReviewItemList
This method retrieves the list of review items of the review.
ReviewItem[] GetReviewItemList(APIContext context, Int32 reviewId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
reviewId |
Integer |
No |
Yes |
The review id. |
Returns the list of all the review items in the review as ReviewItem business objects.
GetReviewItemProfile
This method retrieves a specific review item of the review based upon the asset provided.
ReviewItem GetReviewItemProfile(APIContext context, Int32 reviewId, Int32 assetId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
reviewId |
Integer |
No |
Yes |
The review id. |
assetId |
Integer |
No |
Yes |
The asset Id |
includeStatistics |
Boolean |
Yes |
No |
Flag to determine where to include review item statistics. |
Returns a single review item in the review as a ReviewItem business object.
AddReviewItem
This method adds the asset as a review item to the review.
ReviewItem AddReviewItem(APIContext context, Int32 reviewId, Int32 assetId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
reviewId |
Integer |
No |
Yes |
The review id. |
assetId |
Integer |
No |
Yes |
The asset id. |
Returns the successfully added review item as ReviewItem business object.
RemoveReviewItem
This method removes the review items from the review.
ReviewItem RemoveReviewItem(APIContext context, Int32 reviewId, Int32 assetId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
reviewId |
Integer |
No |
Yes |
The review id. |
assetId |
integer |
No |
Yes |
The asset id. |
Returns the successfully removed review item as ReviewItem business object.
GetReviewResponses
This method retrieves the review responses associated with a review.
ReviewResponses[] GetReviewResponses(APIContext context, Int32 reviewId, Int32? assetId, Int32? referenceId, Int32? referenceType);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
reviewId |
Integer |
No |
Yes |
The review id. |
assetId |
Integer |
Yes |
No |
The asset id. |
referenceId |
Integer |
Yes |
No |
The reference id. |
referenceType |
Integer |
Yes |
No |
The referenceType. |
Returns a list of ReviewResponses as ReviewItem business objects.
AddReviewRole
This method adds a review role.
ReviewRole AddReviewRole(APIContext context, AddReviewRoleDto reviewRole);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
reviewRole |
AddReviewRoleDto |
No |
Yes |
The AddReviewRoleDto object |
Parameter |
Data Type |
Nullable |
Required |
Description |
Code |
String |
No |
Yes |
Review role code |
Name |
String |
No |
Yes |
Review role name |
Permissions |
ReviewRolePermissionsDto |
No |
Yes |
Review role permissions |
ActionRequired |
ReviewRoleActionRequired |
No |
Yes |
Review role Action Required |
EmailSettings |
ReviewRoleEmailSettingDto |
No |
Yes |
Review role email settings |
Parameter |
Data Type |
Nullable |
Required |
Description |
AddCommentReplies |
Boolean |
No |
Yes |
Ability to add comment replies |
AddComments |
Boolean |
No |
Yes |
Ability to add comments |
DeleteAnyComments |
Boolean |
No |
Yes |
Ability to delete comments created by others |
DeleteComments |
Boolean |
No |
Yes |
Ability to delete own comments |
EditAnyCommentReplies |
Boolean |
No |
Yes |
Ability to edit comment replies created by others |
EditAnyComments |
Boolean |
No |
Yes |
Ability to edit comments created by others |
EditCommentReplies |
Boolean |
No |
Yes |
Ability to edit own comment replies |
EditComments |
Boolean |
No |
Yes |
Ability to edit own comment |
PromoteComments |
Boolean |
No |
Yes |
Ability to promote comments |
ResolveFeedbackFlags |
Boolean |
No |
Yes |
Ability to resolve feedback flags |
UseFeedbackFlags |
Boolean |
No |
Yes |
Ability to use feedback flags |
ViewCommentReplies |
Boolean |
No |
Yes |
Ability to view comment replies |
ViewComments |
Boolean |
No |
Yes |
Ability to view comments |
DownloadAssets |
Boolean |
No |
Yes |
Ability to download assets |
Parameter |
Data Type |
Nullable |
Required |
Description |
EmailAssetVersion |
Boolean |
No |
Yes |
Indicates if user is notified when new asset version is added |
EmailReminders |
Boolean |
No |
Yes |
Indicates if email reminders are enabled |
EmailReviewDeleted |
Boolean |
No |
Yes |
Indicates if user is notified when review is deleted |
EmailReviewUpdated |
Boolean |
No |
Yes |
Indicates if user is notified when review is updated |
EmailReviewInvitations |
Boolean |
Yes |
No |
Indicates if user is notified when added to a review |
Returns a ReviewRole.
GetReviewRole
This method retrieves the review role by id.
ReviewRole GetReviewRole(APIContext context, int reviewRoleId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
reviewRoleId |
Integer |
No |
Yes |
The review role id. |
Returns a ReviewRole.
GetReviewRoleList
This method retrieves the review roles associated with account.
ReviewRole[] GetReviewRoleList(APIContext context);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
Returns a list of ReviewRole items.
RemoveReviewRole
This method deletes a review role.
void RemoveReviewRole(APIContext context, int id, int? replacementRoleId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
id |
Integer |
No |
Yes |
The review role id to delete. |
replacementRoleId |
Integer |
Yes |
Yes |
The replacement review role id if the role is in use. |
None
UpdateReviewRole
This method updates a review role.
ReviewRole UpdateReviewRole(APIContext context, UpdateReviewRoleDto reviewRole);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
reviewRole |
UpdateReviewRoleDto |
No |
Yes |
The UpdateReviewRoleDto object |
Parameter |
Data Type |
Nullable |
Required |
Description |
Code |
String |
Yes |
Yes |
Review role code |
Name |
String |
Yes |
Yes |
Review role name |
Permissions |
ReviewRolePermissionsDto |
No |
Yes |
Review role permissions |
ActionRequired |
ReviewRoleActionRequired |
No |
Yes |
Review role Action Required |
EmailSettings |
ReviewRoleEmailSettingDto |
No |
Yes |
Review role email settings |
Parameter |
Data Type |
Nullable |
Required |
Description |
AddCommentReplies |
Boolean |
Yes |
Yes |
Ability to add comment replies |
AddComments |
Boolean |
Yes |
Yes |
Ability to add comments |
DeleteAnyComments |
Boolean |
Yes |
Yes |
Ability to delete comments created by others |
DeleteComments |
Boolean |
Yes |
Yes |
Ability to delete own comments |
EditAnyCommentReplies |
Boolean |
Yes |
Yes |
Ability to edit comment replies created by others |
EditAnyComments |
Boolean |
Yes |
Yes |
Ability to edit comments created by others |
EditCommentReplies |
Boolean |
Yes |
Yes |
Ability to edit own comment replies |
EditComments |
Boolean |
Yes |
Yes |
Ability to edit own comment |
PromoteComments |
Boolean |
Yes |
Yes |
Ability to promote comments |
ResolveFeedbackFlags |
Boolean |
Yes |
Yes |
Ability to resolve feedback flags |
UseFeedbackFlags |
Boolean |
Yes |
Yes |
Ability to use feedback flags |
ViewCommentReplies |
Boolean |
Yes |
Yes |
Ability to view comment replies |
ViewComments |
Boolean |
Yes |
Yes |
Ability to view comments |
DownloadAssets |
Boolean |
Yes |
Yes |
Ability to download assets |
Parameter |
Data Type |
Nullable |
Required |
Description |
EmailAssetVersion |
Boolean |
Yes |
Yes |
Indicates if user is notified when new asset version is added |
EmailReminders |
Boolean |
Yes |
Yes |
Indicates if email reminders are enabled |
EmailAssetVersion |
Boolean |
Yes |
Yes |
Indicates if user is notified when new asset version is added |
EmailReviewDeleted |
Boolean |
Yes |
Yes |
Indicates if user is notified when review is deleted |
EmailReviewUpdated |
Boolean |
Yes |
Yes |
Indicates if user is notified when review is updated |
EmailReviewInvitations |
Boolean |
Yes |
No |
Indicates if user is notified when added to a review |
Returns a ReviewRole.
GetAccountSamlSettings
The method retrieves the account SAML settings.
NOTE: The account SAML settings returned are that of the API endpoint.
AccountSamlSettings GetAccountSamlSettings(APIContext context);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
Returns the AccountSamlSettings business object of the account.
UpdateAccountSamlSettings
The method updates the account SAML settings.
NOTE: The account SAML settings returned are that of the API endpoint.
AccountSamlSettings UpdateAccountSamlSettings(APIContext context, AccountSamlSettings settings);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
settings |
AccountSamlSettings |
No |
Yes |
New account SAML settings. |
Returns the updated AccountSamlSettings business object for the account.
GetProjectRoleList
The method retrieves the list of project roles.
Role[] GetProjectRoleList(APIContext context);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
Returns the list of project roles as Role business objects.
AddProjectRole
This method creates the project role.
Role AddProjectRole(APIContext context, String name, String code);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
name |
String |
No |
Yes |
The name of the project role. |
code |
String |
No |
Yes |
The code of the project role. |
Returns the successfully created project role as Role business object.
UpdateProjectRole
This method updates the project role.
Role UpdateProjectRole(APIContext context, Int32 roleId, String name, String code);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
roleId |
Integer |
No |
Yes |
The project role id. |
name |
String |
No |
Yes |
The name of the project role. |
code |
String |
No |
Yes |
The code of the project role. |
Returns the successfully updated project role as Role business object.
RemoveProjectRole
This method removes the project role.
Role RemoveProjectRole(APIContext context, Int32 roleId, Int32? newRoleId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
roleId |
Integer |
No |
Yes |
The project role id. |
newRoleId |
Integer |
Yes |
No |
The new project role id to replace the old project role if being used on the system. |
Returns the successfully removed project role as Role business object.
GetAccountRoleList
This method retrieves the list of account role.
Role[] GetAccountRoleList(APIContext context);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
Returns the list of account roles as Role business objects.
AddAccountRole
This method creates the account role.
Role AddAccountRole(APIContext context, String name, String code);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
name |
String |
No |
Yes |
The name of the account role. |
code |
String |
No |
Yes |
The code of the account role. |
Returns the successfully created account role as Role business object.
UpdateAccountRole
This method updates the account role.
Role UpdateAccountRole(APIContext context, Int32 roleId, String name, String code);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
roleId |
Integer |
No |
Yes |
The account role id. |
name |
String |
No |
Yes |
The name of the account role. |
code |
String |
No |
Yes |
The code of the account role. |
Returns the successfully updated account role as Role business object.
RemoveAccountRole
This method removes the account role.
Role RemoveAccountRole(APIContext context, Int32 roleId, Int32? newRoleId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
roleId |
Integer |
No |
Yes |
The account role id. |
newRoleId |
Integer |
Yes |
No |
The new account role id to replace the old account role if being used on the system. |
Returns the successfully removed account role as Role business object.
GetInstanceRoleList
This method retrieves the list of account role.
Role[] GetInstanceRoleList(APIContext context);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
Returns the list of instance roles as Role business objects.
AddInstanceRole
This method creates the account role.
Role AddInstanceRole(APIContext context, String name, String code);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
name |
String |
No |
Yes |
The name of the instance role. |
code |
String |
No |
Yes |
The code of the instance role. |
Returns the successfully created instance role as Role business object.
UpdateInstanceRole
This method updates the instance role.
Role UpdateInstanceRole(APIContext context, Int32 roleId, String name, String code);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
roleId |
Integer |
No |
Yes |
The instance role id. |
name |
String |
No |
Yes |
The name of the instance role. |
code |
String |
No |
Yes |
The code of the instance role. |
Returns the successfully updated instance role as Role business object.
RemoveInstanceRole
This method removes the account role.
Role RemoveInstanceRole(APIContext context, Int32 roleId, Int32? newRoleId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
roleId |
Integer |
No |
Yes |
The instance role id. |
newRoleId |
Integer |
Yes |
No |
The new instance role id to replace the old instance role if being used on the system. |
Returns the successfully removed instance role as Role business object.
GetProjectRolePermissionList
This method retrieves the list of project role permissions.
RolePermission[] GetProjectRolePermissionList (APIContext context, Int32 roleId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
roleId |
Integer |
No |
Yes |
The project role's id. |
Returns the list of project role's permissions as RolePermission business objects.
AddProjectRolePermission
This method enables the permission of the project role.
RolePermission AddProjectRolePermission(APIContext context, Int32 roleId, Int32 permissionId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
roleId |
Integer |
No |
Yes |
The project role id. |
permissionId |
Integer |
No |
Yes |
The permission id. |
Returns the successfully enabled project role permission as RolePermission business object.
RemoveProjectRolePermission
This method disables the permission of the project role.
RolePermission RemoveProjectRolePermission(APIContext context, Int32 roleId, Int32 permissionId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
roleId |
Integer |
No |
Yes |
The project role id. |
permissionId |
Integer |
No |
Yes |
The permission id. |
Returns the successfully disabled project role permission as RolePermission business object.
GetAccountRolePermissionList
This method retrieves the list of account role permissions.
RolePermission[] GetAccountRolePermissionList (APIContext context, Int32 roleId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
roleId |
Integer |
No |
Yes |
The account role's id. |
Returns the list of account role's permissions as RolePermission business objects.
AddAccountRolePermission
This method enables the permission of the account role.
RolePermission AddAccountRolePermission(APIContext context, Int32 roleId, Int32 permissionId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
roleId |
Integer |
No |
Yes |
The account role id. |
permissionId |
Integer |
No |
Yes |
The permission id. |
Returns the successfully enabled account role permission as RolePermission business object.
RemoveAccountRolePermission
This method disables the permission of the account role.
RolePermission RemoveAccountRolePermission(APIContext context, Int32 roleId, Int32 permissionId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
roleId |
Integer |
No |
Yes |
The account role id. |
permissionId |
Integer |
No |
Yes |
The permission id. |
Returns the successfully disabled account role permission as RolePermission business object.
GetInstanceRolePermissionList
This method retrieves the list of instance role permissions.
RolePermission[] GetInstanceRolePermissionList (APIContext context);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
roleId |
Integer |
No |
Yes |
The instance role's id. |
Returns the list of instance role's permissions as RolePermission business objects.
AddInstanceRolePermission
This method enables the permission of the instance role.
RolePermission AddInstanceRolePermission(APIContext context, Int32 roleId, Int32 permissionId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
roleId |
Integer |
No |
Yes |
The instance role id. |
permissionId |
Integer |
No |
Yes |
The permission id. |
Returns the successfully enabled instance role permission as RolePermission business object.
RemoveInstanceRolePermission
This method disables the permission of the instance role.
RolePermission RemoveInstanceRolePermission(APIContext context, Int32 roleId, Int32 permissionId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
roleId |
Integer |
No |
Yes |
The instance role id. |
permissionId |
Integer |
No |
Yes |
The permission id. |
Returns the successfully disabled instance role permission as RolePermission business object.
GetResourcePickList
This method returns a list of users/teams/project roles based on the callers visibility to these resources.
AccountResource GetResourcePickList(APIContext context, Int32? intReferenceId, Int32? intReferenceType, Boolean bitIncludeUsers, Boolean bitIncludeTeams, Boolean bitIncludeProjectMembers, Boolean bitIncludeProjectRoles, Int32? intProject, Int32? intTask, Boolean? bitActiveOnly, Boolean? bitCheckCanAdd);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
intReferenceId |
Integer |
Yes |
Yes |
Value to filter results to a specific object (requires intReferenceType to correlate the object type). |
intReferenceType |
Integer |
Yes |
Yes |
Type of object to be filter on based on the intReferenceId provided. |
bitIncludeUsers |
Boolean |
Yes |
False |
Whether to include users or not. |
bitIncludeTeams |
Boolean |
Yes |
False |
Whether to include teams or not. |
bitIncludeProjectMembers |
Boolean |
Yes |
False |
Whether to include project members or not. |
bitIncludeProjectRoles |
Boolean |
Yes |
False |
Whether to include project roles or not. |
intProject |
Integer |
Yes |
True |
Project Id to filter results on. |
intTask |
Integer |
Yes |
True |
Deliverable (formerly task) to filter results on. |
bitActiveOnly |
Boolean |
Yes |
True |
Whether to return only active users or not. |
bitCheckCanAdd |
Boolean |
Yes |
True |
Only returns the resources which the calling user has permission to add to the project and/or deliverable. |
Returns a list of resources (users, teams, project roles) that the caller can see filtered based on properties provided.
GetStatusList
This method retrieves the status list based on the status type.
Status[] GetStatusList(APIContext context, StatusType statusType);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
statusType |
StatusType |
No |
Yes |
The types of status that are retrieved. |
Returns the list of the status based on the status type as Status business objects.
AddStatus
This method creates the status or phase for one of the editable status types.
Status AddStatus(APIContext context, EditableStatusType statusType, String name, String code, String color);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
statusType |
EditableStatusType |
No |
Yes |
The status and phase types that is editable for the Api user. |
name |
String |
No |
Yes |
The name of the status or phase. |
code |
String |
No |
Yes |
The code assigned to the status or phase. |
color |
String |
No |
Yes |
The color assigned to the status or phase. |
Returns the successfully created status or phase as Status business object.
UpdateStatus
This method updates the status or phase for one of the editable status types.
Status UpdateStatus(APIContext context, EditableStatusType statusType, Int32 statusId, String name, String code, String color);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
statusType |
EditableStatusType |
No |
Yes |
The status and phase types that is editable for the api user. |
statusId |
Integer |
No |
Yes |
The status id to update. |
name |
String |
Yes |
No |
The name of the status or phase. |
code |
String |
Yes |
No |
The code assigned to the status or phase. |
color |
String |
Yes |
No |
The color assigned to the status or phase. |
Returns the successfully updated status or phase as Status business object.
RemoveStatus
This method removes the status or phase.
Status RemoveStatus(APIContext context, Int32 statusId, Int32? newStatusId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
statusId |
Integer |
No |
Yes |
The status or phase id. |
newStatusId |
Integer |
Yes |
No |
The new status id to replace the old status if being used on the system. |
Returns the successfully created status or phase as Status business object.
GetStatusGroupList
This method retrieves the status group list based on the status group type.
StatusGroup[] GetStatusGroupList(APIContext context, StatusGroupType statusGroupType);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
statusGroupType |
StatusGroupType |
No |
Yes |
The types of status and phase groups that are retrieved. |
Returns the list of the status groups based on the status group type as StatusGroup business objects.
GetStatusGroupListFromStatus
This method retrieves the status group list that is based on the status id.
StatusGroup[] GetStatusGroupListFromStatus(APIContext context, Int32 statusId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
statusId |
Integer |
No |
Yes |
The status id that is associated with status groups. |
Returns the list of the status groups that are based on the status as StatusGroup business objects.
AddStatusGroup
This method creates the status group.
StatusGroup AddStatusGroup(APIContext context, EditableStatusGroupType statusGroupType, String name, String code);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
statusGroupType |
EditableStatusGroupType |
No |
Yes |
The status and phase group types that is editable for the api user. |
name |
String |
No |
Yes |
The name of the status or phase group. |
code |
String |
No |
Yes |
The code assigned to the status or phase group. |
Returns the successfully created status group as StatusGroup business object.
UpdateStatusGroup
This method updates that status group.
StatusGroup UpdateStatusGroup(APIContext context, EditableStatusGroupType statusGroupType, Int32 statusGroupId, String name, String code);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
statusGroupType |
EditableStatusGroupType |
No |
Yes |
The status and phase group types that is editable for the api user. |
statusGroupId |
Integer |
No |
Yes |
The status group id to update. |
name |
String |
No |
Yes |
The name of the status or phase group. |
code |
String |
Yes |
No |
The code assigned to the status or phase group. |
Returns the successfully updated status group as StatusGroup business object.
RemoveStatusGroup
This method removes the status group.
StatusGroup RemoveStatusGroup(APIContext context, Int32 statusGroupId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
statusGroupId |
Integer |
No |
Yes |
The status group id. |
Returns the successfully removed status group as StatusGroup business object.
GetStatusGroupItemList
This method gets a list of status's based on a status group id.
Status[] GetStatusGroupItemList(APIContext context, Int32 statusGroupId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
statusGroupId |
Integer |
No |
Yes |
The status group id. |
Returns a list of Business status objects based on a StatusGroup.
AddStatusToStatusGroup
This method adds an existing status to a status group.
Status AddStatusToStatusGroup(APIContext context, Int32 statusGroupId, Int32 statusId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
statusGroupId |
Integer |
No |
Yes |
The status group id. |
statusId |
Integer |
No |
Yes |
The status id. |
Returns a status Business object that has been successfully added to a StatusGroup.
RemoveStatusFromStatusGroup
This method removes a status from a status group.
Status RemoveStatusFromStatusGroup(APIContext context, Int32 statusGroupId, Int32 statusId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
statusGroupId |
Integer |
No |
Yes |
The status group id. |
statusId |
Integer |
No |
Yes |
The status id. |
Returns a status Business object that has been successfully removed from a StatusGroup.
GetToDoProfile
This method retrieves the deliverable's todo profile.
ToDo[] GetToDoProfile(APIContext context, Int32 toDoId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
toDoId |
Integer |
No |
Yes |
The deliverable todo id. |
Returns the deliverable todo profile as ToDo business object.
GetToDoList
This method retrieves the list of todo's.
ToDo[] GetToDoList(APIContext context, Int32 projectId, Int32? deliverableId, Int32? assignedToId, ReferenceType? assignedToType, );
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
projectId |
Integer |
No |
Yes |
The project id to search under. |
deliverableId |
Integer |
Yes |
No |
The deliverable id to search under. |
assignedTold |
Integer |
Yes |
No |
The user id or role id the deliverable is assigned to. |
assignedToType |
ReferenceType |
Yes |
No |
The user type or role type of the assigned to id. |
Returns the list of the todo's as Todo business object.
AddToDo
The method creates the deliverable todo.
ToDo AddToDo(APIContext context, Int32? statusId, String name, String code, String description, Int32 projectId, Int32 assignToRefId, ReferenceType assignToType, Int32 referenceId, ToDoReferenceType referenceType, DateTime? dueDate);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
deliverableId |
Integer |
Yes |
No |
The deliverable id. |
statusId |
Integer |
Yes |
No |
The status of the todo. Only the todo statuses are valid. |
name |
String |
No |
Yes |
The name of the todo. |
code |
String |
No |
Yes |
The code of the todo. |
description |
String |
Yes |
No |
The description of the todo. |
projectId |
Integer |
No |
Yes |
The project id of the todo. |
assignToRefld |
Integer |
No |
Yes |
The user id, team id or the role id to assign the todo to. |
assignToRefType |
ReferenceType |
No |
Yes |
The user type, team type or role type of the assigned to id. |
referenceId |
Integer |
No |
Yes |
The project Id or delieverable Id to assigned the todo to. |
referenceType |
Integer |
No |
Yes |
The reference type (project or deliverable). |
dueDate |
DateTime |
Yes |
No |
The due date of the todo in UTC. |
Returns the successfully created deliverable todo as ToDo business object.
UpdateToDo
This method updates the deliverable todo.
ToDo UpdateToDo(APIContext context, Int32 toDoId, Int32? statusId, String name, String code, String description, Int32? projectId, Int32? assignToRefId, ReferenceType? assignToRefType, Int32 referenceId, ToDoReferenceType referenceType, DateTime? dueDate);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
toDoId |
Integer |
No |
Yes |
The todo id. |
statusId |
Integer |
Yes |
No |
The status of the todo. Only the todo statuses are valid. To remove the value assigned -1 needs to be passed in. |
name |
String |
No |
Yes |
The name of the todo. |
code |
String |
No |
Yes |
The code of the todo. |
description |
String |
No |
Yes |
The description of the todo. |
projectId |
Integer |
Yes |
No |
The project id of the todo. |
assignToRefld |
Integer |
Yes |
No |
The user id , team id or the role id to assign the todo to. |
assignToRefType |
ReferenceType |
Yes |
No |
The user type, team type or role type of the assigned to id. |
referenceId |
Integer |
Yes |
No |
The project Id or delieverable Id to assigned the todo to. |
referenceType |
ToDoReferenceType |
Yes |
No |
The reference type (project or deliverable). |
dueDate |
DateTime |
Yes |
No |
The due date of the todo in UTC. To remove the value assigned 1970-01-01 needs to be passed in. |
Returns the successfully updated deliverable todo as ToDo business object.
RemoveToDo
This method removes the todo.
ToDo RemoveToDo(APIContext context, Int32 toDoId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
toDoId |
Integer |
No |
Yes |
The todo id. |
Returns the successfully removed deliverable todo as ToDo business object.
GetMyProfile
This method retrieves the current API user's profile information.
User GetMyProfile(APIContext context);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
Returns the current user's profile as User business object.
UpdateMyProfile
This method updates the current user's profile.
User UpdateMyProfile(APIContext context, String firstName, String lastName, String userName, String ldapName, String password, Int32? timeZoneId, Int32? languageId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
firstName |
String |
Yes |
No |
The first name of the user. |
lastName |
String |
Yes |
No |
The last name of the user. |
userName |
String |
Yes |
No |
The email address of the user. |
ldapName |
String |
Yes |
No |
The lightweight directory access protocol name. |
password |
String |
Yes |
No |
The password of the user profile. |
timeZoneId |
Integer |
Yes |
No |
The timezone assigned to the user. |
languageId |
Integer |
Yes |
No |
The language assigned to the user. |
Returns the successfully updated user profile as User business object.
GetUserProfile
This method retrieves the selected user profile information.
User GetUserProfile(APIContext context, Int32 userId);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
userId |
Integer |
No |
Yes |
The user id to retrieve the profile of. |
Returns the selected users profile as User business object.
AddUser
This method creates a new user and requires partner key credentials.
User AddUser(APIContext context, Boolean? isActive, String firstName, String lastName, String userName, String password, Int32? timeZoneId, Int32? languageId);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
isActive |
Integer |
Yes |
No |
True if the user is active. |
firstName |
String |
No |
Yes |
The first name of the user. |
lastName |
String |
No |
Yes |
The last name of the user. |
userName |
String |
No |
Yes |
The email address for the user. |
password |
String |
Yes |
No |
The password for the user. |
timeZoneId |
Integer |
Yes |
No |
The timezone for the user. |
languageId |
Integer |
Yes |
No |
The language for the user. |
Returns the successfully created user profile as User business object.
UpdateUser
This method updates the selected user's profile information and requires partner key credentials.
User UpdateUser(APIContext context, Int32 userId, String firstName, String lastName, String userName, String ldapName, String password, Int32? timeZoneId, Int32? languageId);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
userId |
Integer |
No |
Yes |
The user id to update the profile for. |
firstName |
String |
Yes |
No |
The first name of the user. |
lastName |
String |
Yes |
No |
The last name of the user. |
userName |
String |
Yes |
No |
The email address of the user. |
ldapName |
String |
Yes |
No |
The lightweight directory access protocol name. |
password |
String |
Yes |
No |
The password of the user profile. |
timeZoneId |
Integer |
Yes |
No |
The timezone assigned to the user. |
languageId |
Integer |
Yes |
No |
The language assigned to the user. |
Returns the successfully update user as User business object.
UpdateUserProfileImage
This method updates the selected user’s profile image and requires partner key credentials.
Boolean UpdateUserProfileImage(APIContext context, Int32 userId, Byte [] fileData);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
userId |
Integer |
No |
Yes |
The user id to update the profile image for. |
fileData |
Byte[] |
No |
Yes |
The byte data of a supported image file (JPG/PNG) |
Returns the successfully update user as User business object.
GetApiToken
This method retrieves the API token of the selected user and requires Partner API authorization.
String GetApiToken(APIContext context, Int32 userId);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
userId |
Integer |
No |
Yes |
The user id to get the api token of. |
Returns the API token for the selected user.
GetUserId
This method retrieves the user id from the email address and requires Partner API authorization.
Int32 GetUserId(APIContext context, String emailAddress);
Requires Partner Token/Password
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api and requires partner key credentials. |
emailAddress |
String |
No |
Yes |
The email address of the user. |
Returns the user id.
GetProjectWorkflowTemplateList
This method retrieves the list of project workflow templates.
Workflow[] GetProjectWorkflowTemplateList(APIContext context);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
Returns the list of the project workflow templates as Workflow business objects.
GetDeliverableWorkflowTemplateList
This method retrieves the list of deliverable workflow templates.
Workflow[] GetDeliverableWorkflowTemplateList(APIContext context);
Parameter |
Data Type |
Nullable |
Required |
Description |
context |
APIContext |
No |
Yes |
Authorizes the user into the Api. |
Returns the list of the deliverable workflow templates as Workflow business objects.