- Home
- VisionProjectWebService
The services available in VisionProject
- Namespace
- http://www.visionproject.se/service/VisionProjectService-v2
- WSDL
- service.wsdl
- Path
- /VisionProjectWebServiceService
login Operation
This method has been deprecated.
Deprecated since v7.5 - use login2 instead
login2 Operation
This method should be used to login to VisionProject with the web service API.
NOTE! This method can only be used if you have an installed version. Use loginWithAPIKey2(username, password, webservicekey, visionProjectVersion)
for the hosted version instead.
A session will also be created if this method is successful.
loginWithAPIKey Operation
This method has been deprecated.
Deprecated since v7.5 - use login2 instead
loginWithAPIKey2 Operation
This method should used to login to VisionProject with the web service API when using the hosted version.
Use login2(username, password, visionProjectVersion) for the installed version instead.
A session will also be created if this method is successful.
logout Operation
Ends the "Web Service Session"
checkUser Operation
Check if the user is valid without creating a session
Return Value
| type |
description |
| boolean
|
true of the user is valid, false otherwise. |
checkUserByChatPassword Operation
Check if the user is valid for chat without creating a session
Return Value
| type |
description |
| boolean
|
true of the user is valid, false otherwise. |
setHashedPasswordForUser Operation
Change the hashedPassword for the specified user. This will set the raw value of the password directly in the
database.
getProject Operation
Gets the specified project.
Return Value
| type |
description |
| Project
|
|
findProjects Operation
Find projects using a specific search criteria object. All attributes set in queryObject will be used in the search.
Return Value
| type |
description |
| list of Project
|
A list of Project objects |
getProjectsForUser Operation
Get all projects that the current user has access to.
Return Value
| type |
description |
| list of Project
|
A list of Project objects |
storeProject Operation
Creates or saves a project. If primaryKey <= 0 the project will be created.
Return Value
| type |
description |
| Project
|
|
deleteProject Operation
Deletes the specified project
copyProject Operation
Copies a project using the attributes in the copyProjectConfig parameter.
Return Value
| type |
description |
| Project
|
|
getUsersForProject Operation
Returns all users for the specified project
Return Value
| type |
description |
| list of SystemUser
|
A list of SystemUser objects |
addUserToProject Operation
Adds a user to a project
removeUserFromProject Operation
Removes a user from a project
getCustomFieldsForProject Operation
Gets the Custom fields for a project
storeCustomFieldsForCustomer Operation
Creates or saves a CustomerGenericCustomField. If primaryKey <= 0 the CustomerGenericCustomField object will be created.
getCustomFieldsForCustomer Operation
Gets the Custom fields for a customer
storeCustomFieldsForProject Operation
Creates or saves a ProjectGenericCustomField. If primaryKey <= 0 the ProjectGenericCustomField object will be created.
getAvailableProjectCustomFields Operation
Gets a list of the custom fields that are available for Projects.
GenericCustomField has a field named customFieldType of type CustomFieldType.
The CustomFieldType has an attribute named "id". This is the meaning of the id field:
- 1 = Text field
- 2 = Select list
- 3 = Boolean field (0 or 1)
- 4 = Date field (Format: yyyy-MM-dd)
- 5 = Multi-select list (Format: |Item1|Item2|)
- 6 = User (no support users) (Valid SystemUser.SystemUserId)
- 7 = User (with support users) (Valid SystemUser.SystemUserId)
- 8 = Date + time field (Format: yyyy-MM-dd HH:mm)
- 9 = Company (Valid Company.CompanyId)
- 10 = "Product" (Configuration item) (Valid ConfigItem.ConfigItemId)
- 11 = URL
- 12 = Integer
- 13 = Decimal
Return Value
| type |
description |
| list of GenericCustomField
|
A list of GenericCustomField objects |
getDocumentsForProjectInFolder Operation
Returns all documents and folders for a project and specific folder
Return Value
| type |
description |
| list of Document
|
An array of Document objects |
getDocumentWithContentForProject Operation
Get one single project document with content
storeProjectDocument Operation
Stores a project document with content
getDocumentFoldersForProject Operation
Get all document folders available for a project
Return Value
| type |
description |
| list of Document
|
An array of Document objects |
getAvailableCustomerCustomFields Operation
Gets a list of the custom fields that are available for Customers.
GenericCustomField has a field named customFieldType of type CustomFieldType.
The CustomFieldType has an attribute named "id". This is the meaning of the id field:
- 1 = Text field
- 2 = Select list
- 3 = Boolean field (0 or 1)
- 4 = Date field (Format: yyyy-MM-dd)
- 5 = Multi-select list (Format: |Item1|Item2|)
- 6 = User (no support users) (Valid SystemUser.SystemUserId)
- 7 = User (with support users) (Valid SystemUser.SystemUserId)
- 8 = Date + time field (Format: yyyy-MM-dd HH:mm)
- 9 = Company (Valid Company.CompanyId)
- 10 = "Product" (Configuration item) (Valid ConfigItem.ConfigItemId)
- 11 = URL
- 12 = Integer
- 13 = Decimal
Return Value
| type |
description |
| list of GenericCustomField
|
A list of GenericCustomField objects |
getCustomFieldsForSystemUser Operation
Gets the Custom fields for a SystemUser
storeCustomFieldsForSystemUser Operation
Creates or saves a SystemUserGenericCustomField. If primaryKey <= 0 the SystemUserGenericCustomField object will be created.
getSystemUserSettingsForSystemUser Operation
Get the Settings object from a SystemUser
storeSystemUserSettings Operation
Saves the SystemUserSettings object
getAvailableCustomerTypes Operation
Get available Customer types
Return Value
| type |
description |
| list of CustomerType
|
CustomerType[] |
getCustomerTypeForCustomer Operation
Get the Customer type for a Customer
storeCustomerTypeForCustomer Operation
Saves the Customer Type for a customer
setPermissionsOnDocument Operation
Set the permissions on a document. If a parameter is null then no change is made to this value on the document.
For example, to set permission on a document with id = X so that only customers Z and Y will have access you
make the following call:
webServiceClient.setPermissionsOnDocument(X, 3, "", "", "|Z|Y|", "");
If you want to add permissions to the above customers and leave all other permission values intact you would make
the follwing call:
webServiceClient.setPermissionsOnDocument(X, 3, null, null, "|Z|Y|", null);
getProjectIssue Operation
Gets a ProjectIssue
storeProjectIssue Operation
Creates or saves a ProjectIssue. If primaryKey <= 0 the issue will be created.
If a new issue should be created it is important to set these attributes at a minimum:
- name
- projectId
- issueStatusId
- issueTypeId
storeProjectIssueNoNotification Operation
Saves a ProjectIssue without send out any Notifications
If a new issue should be created it is important to set these attributes at a minimum:
- name
- projectId
- issueStatusId
- issueTypeId
storeProjectIssueNoDescriptionAttributes Operation
Saves a ProjectIssue without splitting text areas
If a new issue should be created it is important to set these attributes at a minimum:
- name
- projectId
- issueStatusId
- issueTypeId
findProjectIssues Operation
Finds ProjectIssues using a specific search criteria object. All attributes set in queryObject will be used in the search.
Return Value
| type |
description |
| list of ProjectIssue
|
A list of ProjectIssue objects |
findProjectIssuesModifiedInPeriod Operation
Finds ProjectIssues using a specific search criteria object. All attributes set in queryObject will be used in the search.
Return Value
| type |
description |
| list of ProjectIssue
|
A list of ProjectIssue objects |
deleteProjectIssue Operation
Deletes the specified ProjectIssue
getAllSubIssuesForIssue Operation
Returns sub-issues for the specified ProjectIssue
Return Value
| type |
description |
| list of ProjectIssue
|
A list of ProjectIssue object |
getDocumentsForIssue Operation
Get Documents for the specified issue. No content is fetched with this method. Use getDocumentsWithContentForIssue
instead if you need the content as well.
Return Value
| type |
description |
| list of Document
|
A list of Document objects |
getDocumentsWithContentForIssue Operation
Get Documents with content for the specified issue. If you don't need the content, use
getDocumentsWithContentForIssue instead.
getDocumentWithContentForIssue Operation
Get one single issue document with content
storeIssueDocument Operation
Stores an issue document with content
deleteIssueDocument Operation
Delete an issue document
Return Value
| type |
description |
| boolean
|
true if success, false otherwise. |
queryProjectIssues Operation
Query for ProjectIssues.
NOTE: This method is only available for installed customers with their own installation of the system.
Return Value
| type |
description |
| list of ProjectIssue
|
A list of ProjectIssue objects |
getLinkedIssues Operation
Returns info about linked issues.
Return Value
| type |
description |
| list of issueLinkInfo
|
A list of IssueLinkInfo objects |
createIssueLink Operation
Create a link between two issues
deleteIssueLink Operation
Deletes an IssueLink
getAllIssueLinkTypes Operation
Returns all available IssueLinkTypes
Return Value
| type |
description |
| list of IssueLinkType
|
A list of IssueLinkType objects |
getAllCustomFieldForProjectIssue Operation
Returns all Custom fields for issues
Return Value
| type |
description |
| list of CompanyCustomField
|
A list of CompanyCustomField objects |
getAvailableCustomFieldsForProjectIssueInProject Operation
Returns all available Custom fields for issues in the specified project. The IssueField object contains the
mapping between the companyCustomFieldId and the customFieldIndex that can be used to set the correct
companyCustomFieldXX value on the ProjectIssue object.
Return Value
| type |
description |
| list of IssueField
|
A list of IssueField objects |
getAllIssueFieldsForIssueFieldConfiguration Operation
Returns all available Issue fields for the specified IssueFieldConfiguration. The IssueField object contains
information if it's in use or whether it's mandatory etc.
Return Value
| type |
description |
| list of IssueField
|
A list of IssueField objects |
createSystemUser Operation
Creates a new SystemUser
createSystemUserAndAssignToProject Operation
Creates a new SystemUser and assigns the user to an existing project
storeSystemUser Operation
Creates or saves a SystemUser. If primaryKey <= 0 the user will be created.
If an user is created with this methods a notification email will be sent to the newly created user. Use the
method createSystemUser(systemUser, false) if you wouldn't like the user to receive an email.
getSystemUser Operation
Gets the specified SystemUser
findSystemUsers Operation
Finds SystemUsers using a specific search criteria object. All attributes set in queryObject will be used in the search.
Return Value
| type |
description |
| list of SystemUser
|
A list of SystemUser objects |
deleteSystemUser Operation
Deletes the specified SystemUser
getSystemUserStatus Operation
Gets a specified SystemUserStatus
getAllSystemUserStatuses Operation
Gets all available SystemUserStatuses
Return Value
| type |
description |
| list of SystemUserStatus
|
A list of SystemUserStatus objects |
getAllComponentsForProject Operation
This method has been deprecated.
Gets all components for a project
Return Value
| type |
description |
| list of Component
|
A list of Component objects |
getComponent Operation
This method has been deprecated.
Gets a specified Component
getProjectCategory Operation
Gets a specified ProjectCategory
storeProjectCategory Operation
Creates or saves a ProjectCategory. If primaryKey <= 0 the category will be created.
deleteProjectCategory Operation
Deletes the specified ProjectCategory
getAllProjectCategories Operation
Gets all ProjectCategories
Return Value
| type |
description |
| list of ProjectCategory
|
A list of ProjectCategory objects |
getAllIssueHistories Operation
Gets all IssueHistories for an issue
Return Value
| type |
description |
| list of IssueHistory
|
A list of IssueHistory objects |
findIssueHistory Operation
Finds IssueHistories using a specific search criteria object. All attributes set in queryObject will be used in the search.
Return Value
| type |
description |
| list of IssueHistory
|
A list of IssueHistory objects |
Adds an issue comment to an issue. The comment should be in HTML format.
getAllIssueEventTypes Operation
Returns all IssueEventTypes that exists in VisionProject. The issueEventType is used in IssueHistory objects.
Return Value
| type |
description |
| list of IssueEventType
|
A list of IssueEventType objects. |
getProjectVersion Operation
Gets the specified ProjectVersion
findProjectVersions Operation
Finds ProjectVersions using a specific search criteria object. All attributes set in queryObject will be used in the search.
Return Value
| type |
description |
| list of ProjectVersion
|
A list of ProjectVersion objects |
getProjectVersionsForProject Operation
Gets all ProjectVersions for a project
Return Value
| type |
description |
| list of ProjectVersion
|
A list of ProjectVersion objects. |
storeProjectVersion Operation
Creates or saves a ProjectVersion. If primaryKey <= 0 the version will be created.
deleteProjectVersion Operation
Deletes the specified ProjectVersion
getIssueStatus Operation
Gets a specified IssueStatus
getAllIssueStatuses Operation
Gets all available IssueStatuses
Return Value
| type |
description |
| list of IssueStatus
|
A list of IssueStatus objects. |
getIssueType Operation
Gets a specified IssueType
getAllIssueTypes Operation
Gets all available IssueTypes
Return Value
| type |
description |
| list of IssueType
|
A list of IssueType objects |
getIssueResolution Operation
Gets a specified IssueResolution
getAllIssueResolutions Operation
Gets all available IssueResolutions
Return Value
| type |
description |
| list of IssueResolution
|
A list of IssueResolution objects |
getInteractionStatus Operation
Gets a specified InteractionStatus
getAllInteractionStatuses Operation
Gets all available InteractionStatuses
Return Value
| type |
description |
| list of InteractionStatus
|
A list of InteractionStatus objects |
getIssueUrgency Operation
Gets a specified IssueUrgency
getAllIssueUrgencies Operation
Gets all available IssueUrgencies
Return Value
| type |
description |
| list of IssueUrgency
|
A list of IssueUrgency objects |
getIssueEscalationLevel Operation
Gets a specified IssueEscalationLevel
getAllIssueEscalationLevels Operation
Gets all available IssueEscalationLevels
getProjectBuild Operation
Gets a specified ProjectBuild
storeProjectBuild Operation
Creates or saves a ProjectBuild. If primaryKey <= 0 the build will be created.
findProjectBuilds Operation
Finds ProjectBuilds using a specific search criteria object. All attributes set in queryObject will be used in the search.
Return Value
| type |
description |
| list of ProjectBuild
|
A list of ProjectBuild objects |
deleteProjectBuild Operation
Deletes the specified ProjectBuild
getProjectStatus Operation
Gets the specified ProjectStatus
getAllProjectStatuses Operation
Gets all available ProjectStatuses
Return Value
| type |
description |
| list of ProjectStatus
|
A list of ProjectStatus objects |
getIssueSeverity Operation
Gets the specified IssueSeverity
getAllIssueSeverities Operation
Gets all available IssueSeverities
Return Value
| type |
description |
| list of IssueSeverity
|
A list of IssueSeverity objects |
getIssuePriority Operation
Gets a specified IssuePriority
getAllIssuePriorities Operation
Gets all available IssuePriorities
Return Value
| type |
description |
| list of IssuePriority
|
A list of IssuePriority objects |
getIssueWorkLogsForPeriod Operation
Returns all matching IssueWorkLog objects
Return Value
| type |
description |
| list of IssueWorkLog
|
A list of IssueWorkLog objects |
storeIssueWorkLog Operation
Creates or saves a IssueWorkLog. If primaryKey <= 0 the worklog will be created.
getIssueWorkLog Operation
Gets the specified IssueWorkLog
getAllIssueWorkLogs Operation
Gets all IssueWorkLogs for an issue
Return Value
| type |
description |
| list of IssueWorkLog
|
A list of IssueWorkLog objects |
deleteIssueWorkLog Operation
Deletes an IssueWorkLog
getAllWorkLogCategories Operation
Returns all available Worklog categories
Return Value
| type |
description |
| list of WorkLogCategory
|
A list of WorkLogCategory objects |
getCostsForPeriod Operation
Returns all matching Cost objects
Return Value
| type |
description |
| list of Cost
|
A list of Cost objects |
storeCost Operation
Creates or saves a Cost. If primaryKey <= 0 the cost will be created. To specify a Cost on a ProjectIssue both
projectIssueId and projectId must be specified and > 0. If you want to create a Cost on a Project you don't
set the projectIssueId on the object (or set it to 0).
Return Value
| type |
description |
| Cost
|
|
getCost Operation
Gets the specified Cost
Return Value
| type |
description |
| Cost
|
|
getAllCostsForIssue Operation
Gets all Costs for an issue
Return Value
| type |
description |
| list of Cost
|
A list of Cost objects |
getAllCostsForProject Operation
Gets all Costs for a project (where projectIssueId = NULL)
Return Value
| type |
description |
| list of Cost
|
A list of Cost objects |
deleteCost Operation
Deletes a Cost
getAllCostTypes Operation
Returns all available Cost types
Return Value
| type |
description |
| list of CostType
|
A list of CostType objects |
findUserGroups Operation
Finds UserGroups using a specific search criteria object. All attributes set in queryObject will be used in the search.
Return Value
| type |
description |
| list of UserGroup
|
A list of UserGroup objects |
findUserRoles Operation
Finds VPRoles using a specific search criteria object. All attributes set in queryObject will be used in the search.
Return Value
| type |
description |
| list of VPRole
|
A list of VPRole objects |
storeCustomer Operation
Creates or saves a Customer . If primaryKey <= 0 the customer will be created.
getCustomer Operation
Gets the specified Customer
findCustomers Operation
Finds Customers using a specific search criteria object. All attributes set in queryObject will be used in the search.
Return Value
| type |
description |
| list of Customer
|
A list of Customer objects |
deleteCustomer Operation
Deletes the specified Customer
getAllCustomerStatuses Operation
Returns all customer statuses
Return Value
| type |
description |
| list of EntityStatus
|
List of EntityStatus |
getConfigItem Operation
Gets the specified config item.
findConfigItems Operation
Find config items using a specific search criteria object. All attributes set in queryObject will be used in the search.
Return Value
| type |
description |
| list of ConfigItem
|
A list of ConfigItem objects |
getConfigItemChildrens Operation
Get all childrens for a config item id. If you want to get all ConfigItems on the first level call this method
like this: getConfigItemChildrens(0);
Return Value
| type |
description |
| list of ConfigItem
|
A list of ConfigItem objects |
storeConfigItem Operation
Creates or saves a config item. If primaryKey <= 0 the config item will be created.
deleteConfigItem Operation
Deletes the specified config item
getCustomFieldsForConfigItem Operation
Gets the Custom fields for a config item
getCustomFieldsForAllConfigItems Operation
Gets all Custom fields for all Config items
Return Value
| type |
description |
| list of ConfigItemGenericCustomField
|
List of ConfigItemGenericCustomField items. ConfigItemGenericCustomField is an object that contains the custom fields for a config item |
storeCustomFieldsForConfigItem Operation
Creates or saves a ConfigItemGenericCustomField. If primaryKey <= 0 the ConfigItemGenericCustomField object will be created.
getAvailableConfigItemCustomFields Operation
Gets a list of the custom fields that are available for ConfigItem.
GenericCustomField has a field named customFieldType of type CustomFieldType.
The CustomFieldType has an attribute named "id". This is the meaning of the id field:
- 1 = Text field
- 2 = Select list
- 3 = Boolean field (0 or 1)
- 4 = Date field (Format: yyyy-MM-dd)
- 5 = Multi-select list (Format: |Item1|Item2|)
- 6 = User (no support users) (Valid SystemUser.SystemUserId)
- 7 = User (with support users) (Valid SystemUser.SystemUserId)
- 8 = Date + time field (Format: yyyy-MM-dd HH:mm)
- 9 = Company (Valid Company.CompanyId)
- 10 = "Product" (Configuration item) (Valid ConfigItem.ConfigItemId)
- 11 = URL
- 12 = Integer
- 13 = Decimal
Return Value
| type |
description |
| list of GenericCustomField
|
A list of GenericCustomField objects |
getAllConfigItemTypes Operation
Returns all Config item types
Return Value
| type |
description |
| list of ConfigItemType
|
List of ConfigItemType objects |
getAllConfigItemStatuses Operation
Returns all Config item statuses
Return Value
| type |
description |
| list of EntityStatus
|
List of EntityStatus |
getDocumentsForConfigItemInFolder Operation
Returns all documents and folders for a config item and specific folder
Return Value
| type |
description |
| list of Document
|
An array of Document objects |
getDocumentWithContentForConfigItem Operation
Get one single config item document with content
storeConfigItemDocument Operation
Stores a config Item document with content
getConfigItemLinkTypes Operation
Get ConfigItem link types
Return Value
| type |
description |
| list of ConfigItemLinkType
|
A list of ConfigItemLinkType objects |
getLinkedConfigItems Operation
Get config items that is linked to the specified ConfigItem
Return Value
| type |
description |
| list of ConfigItem
|
A list of ConfigItem objects |
getConfigItemLinks Operation
Get the objects that is holding the Config item links information
Return Value
| type |
description |
| list of ConfigItemLink
|
A list of ConfigItemLink objects |
createConfigItemLink Operation
Create a link between two ConfigItems
deleteConfigItemLink Operation
Delete a link between config items
getContract Operation
Gets the specified contract.
findContracts Operation
Find contracts using a specific search criteria object. All attributes set in queryObject will be used in the search.
Return Value
| type |
description |
| list of Contract
|
A list of Contract objects |
storeContract Operation
Creates or saves a contract. If primaryKey <= 0 the config item will be created.
deleteContract Operation
Deletes the specified contract
getCustomFieldsForContract Operation
Gets the custom fields for a contract
getCustomFieldsForAllContracts Operation
Gets all custom fields for all contracts
Return Value
| type |
description |
| list of ContractGenericCustomField
|
List of ContractGenericCustomField items. ContractGenericCustomField is an object that contains the custom fields for a contract |
storeCustomFieldsForContract Operation
Creates or saves a ContractGenericCustomField. If primaryKey <= 0 the ContractGenericCustomField object will be created.
getAvailableContractCustomFields Operation
Gets a list of the custom fields that are available for Contract.
GenericCustomField has a field named customFieldType of type CustomFieldType.
The CustomFieldType has an attribute named "id". This is the meaning of the id field:
- 1 = Text field
- 2 = Select list
- 3 = Boolean field (0 or 1)
- 4 = Date field (Format: yyyy-MM-dd)
- 5 = Multi-select list (Format: |Item1|Item2|)
- 6 = User (no support users) (Valid SystemUser.SystemUserId)
- 7 = User (with support users) (Valid SystemUser.SystemUserId)
- 8 = Date + time field (Format: yyyy-MM-dd HH:mm)
- 9 = Company (Valid Company.CompanyId)
- 10 = "Product" (Configuration item) (Valid ConfigItem.ConfigItemId)
- 11 = URL
- 12 = Integer
- 13 = Decimal
Return Value
| type |
description |
| list of GenericCustomField
|
A list of GenericCustomField objects |
getAllContractTypes Operation
Returns all contract types
Return Value
| type |
description |
| list of ContractType
|
List of ContractType objects |
getAllContractStatuses Operation
Returns all contract statuses
Return Value
| type |
description |
| list of EntityStatus
|
List of EntityStatus |
getDocumentsForContractInFolder Operation
Returns all documents and folders for a contract and specific folder
Return Value
| type |
description |
| list of Document
|
An array of Document objects |
getDocumentWithContentForContract Operation
Get one single contract document with content
storeContractDocument Operation
Stores a contract document with content
getIssueSubscribers Operation
Returns an object that contains SystemUsers and UserGroups that is added as a subscriber on an issue
addSystemUserAsIssueSubscriber Operation
Adds a SystemUser as an issue subscriber on an issue
removeSystemUserAsIssueSubscriber Operation
Removes a SystemUser as an issue subscriber on an issue
addUserGroupAsIssueSubscriber Operation
Adds a UserGroup as an issue subscriber on an issue
removeUserGroupAsIssueSubscriber Operation
Adds a SystemUser as an issue subscriber on an issue
getAllQueries Operation
Get an array of all Queries (Searches) the current user have access to.
Return Value
| type |
description |
| list of Query
|
an array of Query objects |
getQuery Operation
Get details of a specific Query.
Return Value
| type |
description |
| Query
|
|
getQueryResult Operation
Get an array of ProjectIssue objects that is the result of executing the specified Query.
Return Value
| type |
description |
| list of ProjectIssue
|
an array of ProjectIssue objects |
getProjectIssuesForQuery Operation
Get a paginated array of ProjectIssue objects that is the result of executing the specified Query.
Return Value
| type |
description |
| list of ProjectIssue
|
an array of ProjectIssue objects |
getQueryResultCount Operation
Get the number of ProjectIssue objects resulting from the execution of the specified Query.
Return Value
| type |
description |
| int
|
the number of ProjectIssues |
getSubscribedProjectIssuesForUser Operation
Load array of ProjectIssue objects that the specified user is subscribed to
Return Value
| type |
description |
| list of int
|
|