Digite Webservices API

Table of Contents

  1. Introduction
  2. Overview
    1. Parameter Naming Conventions.
    2. ExternalEmployeeId, ExternalProjectCode and ExternalOrgCode parameters
  3. Web Services Definitions.
    1. Login Web service.
      1. LoginForToken ()
      2. LoginForToken ()
    2. User Entity Web services.
      1. CreateUser ()
      2. LockUser ()
      3. UnlockUser ()
      4. GetUserDetails ()
      5. SetUserRelationshipToOrg ()
      6. UpdateUserDetails ()
      7. UpdateUserPassword ()
      8. UpdateUserRoles ()
      9. RemoveUserRelationshipToOrg ()
    3. Organization Entity Web services.
      1. CreateOrganization ()
      2. GetOrganizationDetails ()
      3. UpdateOrganizationDetails ()
      4. SetOrgRelationshipToOrg ()
      5. RemoveOrgRelationshipToOrg ()
    4. Project Entity Webservices.
      1. CreateProjectRegistration ()
      2. GetProjectDetails ()
      3. SetProjectRelationshipToOrg ()
      4. GetProjectIdFromCode ()
      5. UpdateProjectDetails ()
      6. CloseProject ()
      7. RemoveProjectRelationshipToOrg ()
    5. Team Member Webservices.
      1. AddTeamMemberToProject ()
      2. GetTeamMemberInfo ()
      3. AssignRolesToTeamMember ()
      4. AddTeamMembersToProjectInBulk ()
      5. UpdateTeamMemberDetailsInBulk ()
      6. DeleteTeamMembersFromProjectInBulk ()
      7. UnAssignTeamMembersFromProjectInBulk ()
      8. ReAssignTeamMembersToProjectInBulk ()
      9. GetTeamMembersInfo ()
      10. GetTeamMemberId ()
    6. Team Member Allocation Webservices.
      1. AddTeamMemberAllocation ()
      2. AddBulkTeamMemberAllocation ()
      3. GetTeamMemberAllocationsInfo ()
      4. GetTeamMemberAllocationInfo ()
      5. UpdateTeamMemberAllocationsDetailsInBulk ()
      6. AssignRolesToTeamMemberAllocation ()
    7. Generic Eform Services.
      1. CreateEformItemWithData ()
      2. ModifyEformItem ()
      3. ModifyEformItem ()
      4. DeleteEformItem ()
      5. DeleteEformItem ()
      6. CloseEformItem ()
      7. CloseEformItem ()
      8. getFieldValueBoolean ()
      9. getFieldValueString ()
      10. getFieldValueInt ()
      11. getFieldValueFloat ()
      12. setFieldValueBoolean ()
      13. setFieldValueString ()
      14. setFieldValueInt ()
      15. setFieldValueFloat ()
      16. AddComments ()
      17. getEformItemStatus ()
      18. AddActivityLog ()
      19. GetCurrentWorkflowStageName ()
      20. SetTraceability ()
    8. Eclipse Integration Services.
      1. GetEformItemList ()
      2. GetProjectList ()
      3. GetEformDetail ()
      4. GetAttachmentContent ()
      5. GetEclipsePluginVersion ()
      6. GetLoggedInUserInfo ()
      7. GetProjectInfo ()
      8. Logout ()
      9. AddAttachment ()
      10. AddComments ()

1. Introduction

This document describes the Digite Web services interface definitions, which will help enterprises to integrate with Digite application in a more programmatic manner. The Web services collection provided by Digite is continuously growing based on the Customer requirements and new features introduction in application. So if services expected by the user of this document are not found here, we request him to contact Digite for further steps. The Web services defined in this document have been grouped under their respective Module heading.

2. Overview

All the Digite Web services have been implemented to provide RPC/encoded style binding and not Document/literal style, which means that they all accept primitive data types as input parameters and return primitive data type as result. Web services work only after authentication i.e. Client program needs to call LoginForToken () web service once to generate the security token, which must be set in the request header of every subsequent web service call. Absence of this token will make all the web services fail. Token supports the expiry period and it can be configured by using Digite system properties. All the date parameters, though declared as String type, must be passed in "dd-MMM-yyyy HH:mm:s" format e.g. 15-Feb-2007 15:30:20.

Digite Web services generally fall in the following three categories:

- Create Data

- Modify Data

- Retrieve Data

Web services providing "Create Data" functionality return the primary key to the data created and the same primary key must be used to modify or Retrieve the same data. In some cases the same key may also be required even in "Create Data" to create sub-data or sub-items as parent key. If client is not using the Digite Web services to create data but wants to modify or retrieve data using Web services, he will have to either refer to Digite database by firing SQL queries to retrieve primary keys or to Digite UI by extracting primary key information from the URLs. Both the approaches may require help from Digite support. Following sections describe each and every service in detail.

2.1. Parameter Naming Conventions

The parameters ending with "Id" generally refer to Digite primary keys, which are unique numbers, whereas parameters ending with "Code" refer to an Item attribute labeled "Id" in Digite UI screens.

2.2. ExternalEmployeeId, ExternalProjectCode and ExternalOrgCode parameters

Any of the web services using the above mentioned parameters will have following meaning incase that particular item has not been created using Digite web services but by Digite UI or some other means. If the item has been created using web services then you can ignore this section and jump to next one.

⇒  ExternalEmployeeId: If the user is not created using Digite web service CreateUser() then you need to pass Digite "LoginId" for this parameter.

⇒ ExternalProjectCode: If the project is not created using Digite web service CreateProjectRegistration () then you need to pass Digite "Project Id", as visible in Project profile screen with label "Project Id", for this parameter.

⇒ ExternalOrgCode: If the Organization is not created using Digite web service CreateOrganization() then you need to pass Digite "Organization Id", as visible in Organization profile screen with label "Id", for this parameter.

3. Web Services Definitions

3.1. Login Web service

3.1.1 LoginForToken ()

This service generates the security token, which needs to be set in the request header of every web service call except this one. Since this method accepts Encrypted password, one UI page will be provided (It will be provided by Digite support on request), which will accept plain text password and create encrypted password. It will use 64 bit DES ciphering method to encrypt the password. The password generated by this page will be passed to the following method to generate the token. The token should be set in header while calling any of the Webservices except LoginForToken (). If no token is found, error will be thrown. Token expiry period can be specified in system.properties file. The name of the property will be WSTOKEN_EXPIRY_PERIOD. It will be defined in minutes.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

LoginId

String

Digite LoginId

Not null

2

Password

String

Encrypted Password

Not null

Output:

Type

Description

String

It Will return security token, which needs to be set in the request header of every subsequent Webservice call.

3.1.2 LoginForToken ()

This is to be used for SaaS enabled deployment. This webservice is same as LoginForToken mentioned in section 3.1.1 except that it takes additional parameter SaaSKey (used in login page as value for Key attribute).

Note: for Axis2.x use "LoginForTokenWithSaasKey" to call the WebService.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

LoginId

String

Digite LoginId

Not null

2

Password

String

Encrypted Password

Not null

3

SaasKey

String

Saas Key

Null allowed

Output:

Type

Description

String

It Will return security token which needs to be set in the request header of every subsequent Webservice call.

3.2. User Entity Web services

3.2.1 CreateUser ()

This service provides the functionality of User creation in one of the enterprise in Digite application. The various attributes of a user can be set by passing appropriate values as parameters. Refer to parameter list for more details.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

LoginId

String

Digite LoginId of the user

Not null

2

FirstName

String

First name of the user

Not null

3

LastName

String

Last name of the user

Not null

4

Email

String

Email id of the user

Not null and valid email

5

Password

String

User password

Not null and must be clear text.

6

OrgRoles

String[]

Organization Role names, already created in Digite, to be assigned to this user.

Null allowed

7

PLRs

String[]

PLR names, already created in Digite, to be assigned to this user.

Null allowed

8

ExternalEmployeeId

String

External Employee Id will be used to refer to any user related Web services. If passed null Digite Userid will be used for this field, which is the return value of this method.

Null allowed

9

EntCode

String

Code of an enterprise in which this user is to be added.

Not null

10

ExternalOrgCode

String

Organization Code to which this user needs to be attached. ExternalOrgCode passed in CreateOrganization method. If the ExternalOrgCode is passed as null in the CreateOrganization method then this field will accept the return value of the CreateOrganization method (OrganizationId).

Null allowed, If null will be attached to root org

11

CustFieldLabels

String[]

Array of custom field labels, which need to be set.

Null allowed

12

CustFieldValues

String[]

Array of custom field values for fields specified in previous parameter.

Null allowed

13

UserDN

String

User's DN in ldap server, if integrating with ldap server else specify null.

Null allowed

Output:

Type

Description

Int

Userid of the created user. It is primary key in digite. Exception will be thrown in case of any error.

3.2.2 LockUser ()

This API will lock the user in Digite.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ExternalEmployeeId

String

ExternalEmployeeId passed in CreateUser method. If the ExternalEmployeeId is passed as null in the CreateUser method this field will accept the return value of the CreateUser method.

Not null

Output:

Type

Description

Void

It will throw exception, if User could not be locked because of some business rule or error. No exception will be thrown if user is already locked.

3.2.3 UnlockUser ()

This API will unlock the user in Digite.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ExternalEmployeeId

String

ExternalEmployeeId passed in CreateUser method. If the ExternalEmployeeId is passed as null in the CreateUser method this field will accept the return value of the CreateUser method

Not null

Output:

Type

Description

Void

It will throw exception, if User could not be unlocked because of some business rule or error. No exception will be thrown if user is not locked.

3.2.4 GetUserDetails ()

This API will retrieve the User Information. Refer to output table for details.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ExternalEmployeeId

String

ExternalEmployeeId passed in CreateUser method. If the ExternalEmployeeId is passed as null in the CreateUser method this field will accept the return value of the CreateUser method

Not null

Output:

Type

Description

String

Will return the User Info in the following XML format.

<Users>

<User>

<FieldName>FieldValue</FieldName>

</User>

</Users>

Where FieldName is the label of the field that you will see on screen. Exception will be thrown in case of any error.

3.2.5 SetUserRelationshipToOrg ()

It sets the specified relationship between Organization and User.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ExternalEmployeeId

String

ExternalEmployeeId passed in CreateUser method. If the ExternalEmployeeId is passed as null in the CreateUser method this field will accept the return value of the CreateUser method

Not null

2

ExternalOrgCode

String

ExternalOrgCode passed in CreateOrganization method. If the ExternalOrgCode is passed as null in the CreateOrganization method this field will accept the return value of the CreateOrganization method (OrganizationId).

Not null

3

RelationshipType

String

Org-User Relationship Name already created in Digite, to be assigned to User.

Not null

Output:

Type

Description

Void

Exception will be thrown in case of any error.

3.2.6 UpdateUserDetails ()

This API will update the User entity attributes.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ExternalEmployeeId

String

Id of user to be updated. ExternalEmployeeId passed in CreateUser method. If the ExternalEmployeeId is passed as null in the CreateUser method this field will accept the return value of the CreateUser method.

Not null

2

FirstName

String

First name of the user

Not null

3

LastName

String

Last name of the user

Not null

4

Email

String

Email id of the user

Not null and valid email

5

CustFieldLabels

String[]

Array of custom field labels. Fields not passed should not be updated even if they are mandatory.

Null allowed

6

CustFieldValues

String[]

Array of custom field values for fields specified in the previous parameter in the same index order

Null allowed

7

UserDN

String

User's DN in ldap server, if integrating with ldap server else specify null

Null allowed, if null don't update this field

Output:

Type

Description

Void

Exception will be thrown in case of any error.

3.2.7 UpdateUserPassword ()

This API will update the User's password.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ExternalEmployeeId

String

Id of user to be updated. ExternalEmployeeId passed in CreateUser method. If the ExternalEmployeeId is passed as null in the CreateUser method this field will accept the return value of the CreateUser method.

Not null

2

Password

String

User password

Not null and clear text.

Output:

Type

Description

Void

Exception will be thrown in case of any error.

3.2.8 UpdateUserRoles ()

This API will help updating the User's Organization role and Project level Org roles (PLRs). This API will clear all the previous roles and assign the new roles provided in input.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ExternalEmployeeId

String

ExternalEmployeeId passed in CreateUser method. If the ExternalEmployeeId is passed as null in the CreateUser method this field will accept the return value of the CreateUser method.

Not null

2

OrgRoles

String[]

Organization Role names to be assigned to user

Null allowed, If null don't update the current values

3

PLRs

String[]

PLR names to be assigned to user

Null allowed, If null don't update the current values

4

PLRFilters

String[]

PLR filter associated to PLR role given in the previous parameter. PLR Filter passed should be global project filter and not user personal filter.

Null allowed, If null don't update the current values

Output:

Type

Description

Void

Exception will be thrown in case of any error.

3.2.9 RemoveUserRelationshipToOrg ()

This API can be used to remove an existing relationship between user and an organization.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ExternalEmployeeId

String

Id of user to be updated. ExternalEmployeeId passed in CreateUser method. If the ExternalEmployeeId is passed as null in the CreateUser method this field will accept the return value of the CreateUser method

Not null

2

ExternalOrgCode

String

ExternalOrgCode passed in CreateOrganization method. If the ExternalOrgCode is passed as null in the CreateOrganization method this field will accept the return value of the CreateOrganization method (OrganizationId).

Not null

3

RelationshipType

String

Org-User Relationship Name

Not null

Output:

Type

Description

Void

Exception will be thrown in case of any error.

3.3. Organization Entity Web services

3.3.1 CreateOrganization ()

It provides Organization creation functionality along with setting its attributes. Refer to Input parameter list for more details.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ExternalEmployeeId

String

ExternalEmployeeId passed in CreateUser method. If the ExternalEmployeeId is passed as null in the CreateUser method this field will accept the return value of the CreateUser method

Not null

2

EntCode

String

Code of enterprise in which this Org is to be created.

Not null

3

ExternalOrgCode

String

External Org Code, will be used to refer to any org related Web services If passed null Digite OrganizationId will be used for this field, which will be the return value of this method.

Null allowed, if null then return value of this API will be used as External Orgcode.

4

CustFieldLabels

String[]

Array of Organization eform field labels, which need to be set

Null allowed

5

CustFieldValues

String[]

Array of values for fields specified in the previous parameter.

Null allowed

Output:

Type

Description

Int

OrganizationId of the created Organization. It is primary key in digite. Exception will be thrown in case of any error.

3.3.2 GetOrganizationDetails ()

Use this API to retrieve the Organization details. The output format is described in the output table.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ExternalOrgCode

String

ExternalOrgCode passed in CreateOrganization method. If the ExternalOrgCode is passed as null in the CreateOrganization method this field will accept the return value of the CreateOrganization method (OrganizationId).

Not null

Output:

Type

Description

String

Will return the Organization Info in the following XML format.

<Organizations>

<Organization>

<FieldName>FieldValue</FieldName>

</ Organization>

</ Organizations >

Where FieldName is the label of the field that you will see on screen. Exception will be thrown in case of any error.

3.3.3 UpdateOrganizationDetails ()

This API will update the Organization details provided as input.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ExternalEmployeeId

String

Id of user updating this Org details. ExternalEmployeeId passed in CreateUser method. If the ExternalEmployeeId is passed as null in the CreateUser method this field will accept the return value of the CreateUser method. This is the id of user who is modifying the Org details.

Not null

2

ExternalOrgCode

String

Id of the Org to be updated. ExternalOrgCode passed in CreateOrganization method. If the ExternalOrgCode is passed as null in the CreateOrganization method this field will accept the return value of the CreateOrganization method (OrganizationId).

Not null

3

CustFieldLabels

String[]

Array of custom field labels to be updated. Fields not passed should not be updated even if they are mandatory.

Null allowed

4

CustFieldValues

String[]

Array of custom field values for fields specified in previous parameter

Null allowed

Output:

Type

Description

Void

Exception will be thrown in case of any error.

3.3.4 SetOrgRelationshipToOrg ()

Use this API to set organization relationship between two organizations.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ExternalOrgCodeParent

String

Parent Org Id. ExternalOrgCode passed in CreateOrganization method. If the ExternalOrgCode is passed as null in the CreateOrganization method this field will accept the return value of the CreateOrganization method

Not null

2

ExternalOrgCodeChild

String

Child Org Id. ExternalOrgCode passed in CreateOrganization method. If the ExternalOrgCode is passed as null in the CreateOrganization method this field will accept the return value of the CreateOrganization method

Not null

3

RelationshipType

String

Org-Org Relationship Name

Not null

Output:

Type

Description

Void

Exception will be thrown in case of any error.

3.3.5 RemoveOrgRelationshipToOrg ()

Use this API to remove an existing relationship between two organizations.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ExternalOrgCodeParent

String

Parent Org Id. ExternalOrgCode passed in CreateOrganization method. If the ExternalOrgCode is passed as null in the CreateOrganization method this field will accept the return value of the CreateOrganization method

Not null

2

ExternalOrgCodeChild

String

Child Org Id. ExternalOrgCode passed in CreateOrganization method. If the ExternalOrgCode is passed as null in the CreateOrganization method this field will accept the return value of the CreateOrganization method

Not null

3

RelationshipType

String

Org-Org Relationship Name

Not null

Output:

Type

Description

Void

Exception will be thrown in case of any error.

3.4. Project Entity Webservices

3.4.1 CreateProjectRegistration ()

Digite provides functionality to force the project creation through registration process, where you have to first create the Project registration request and on closure of this request project gets created automatically. This API provides capability to create the project registration request, which then needs to be followed up and closed using Digite UI.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

CreatorExternalEmployeeId

String

ExternalEmployeeId passed in CreateUser method. If the ExternalEmployeeId is passed as null in the CreateUser method this field will accept the return value of the CreateUser method

Not null

2

ExternalProjectCode

String

External Project Code will be used to refer to any project related Webservices. If passed Null, digite's ProjectId (Primary Key) will be used for this field.

Null allowed

3

ProjectName

String

Name of the Project

Not null

4

PlannedStartDate

String

Project planned start date

Not null

5

PlannedEndDate

String

Project planned End Date

Not null

6

Priority

String

Project Priority

Not null

7

ProjectManagerExternalEmployeeId

String

ExternalEmployeeId passed in CreateUser method. If the ExternalEmployeeId is passed as null in the CreateUser method this field will accept the return value of the CreateUser method

Not null

8

ClientName

String

 

Null allowed

9

TaskModule

String

Only "Microsoft Project" supported at this point.

Null allowed

10

IsProgram

String

Either "Y" or "N". Default "N"

Null allowed. If null then "N"

11

Description

String

Project Description

Null allowed

12

CustFieldLabels

String[]

Array of custom field labels, which will be copied to Project after project creation. You can also pass ActualStartDate and ActualEndDate

Not Null

13

CustFieldValues

String[]

Array of custom field values, which will be copied to Project Eform after project creation.

Not Null

14

Workflowstages

String[]

Workflow stage labels of Project Registration form, which need to be assigned users.

Null allowed

15

WorkflowAssignments

String[]

Workflow stage actors (comma separated LoginIds for multiple actors), for stages provided in the previous parameter.

Null allowed

Output:

Type

Description

Int

RegistrationId. It is primary key in digite. Exception will be thrown in case of any error.

3.4.2 GetProjectDetails ()

It retrieves the Project details. Refer to output table for format details.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ExternalProjectCode

String

ProjectCode passed in CreateProjectRegistration(), If passed null there then it will refer to digite's ProjectId (primary key)

Not null

Output:

Type

Description

String

Will return the Project Info in the following XML format.

<Projects>

<Project>

<FieldName>FieldValue</FieldName>

</ Project>

</ Projects >

Where FieldName is the label of the field that you will see on screen. Exception will be thrown in case of any error.

3.4.3 SetProjectRelationshipToOrg ()

It sets the relationship between Project and an Organization.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ExternalProjectCode

String

ProjectCode passed in CreateProjectRegistration(), If passed null there then it will refer to digite's ProjectId (primary key)

Not null

2

ExternalOrgCode

String

ExternalOrgCode passed in CreateOrganization method. If the ExternalOrgCode is passed as null in the CreateOrganization method this field will accept the return value of the CreateOrganization method

Not null

3

RelationshipType

String

Org-Prj Relationship Name

Not null

Output:

Type

Description

Void

Exception will be thrown in case of any error.

3.4.4 GetProjectIdFromCode ()

It retrieves the ProjectId, which is Digite's ProjectId and considered to be primary key for the given Project Code. Project Code, as described at the beginning of the document is the value of a Project attribute called "Id" and is visible in Digite's UI as "Project Id". This API may be helpful to retrieve the ProjectId, which is required in many of the generic Eform web services.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ProjectCode

String

ProjectCode as visible in Digite's Project Profile screen as "Project Id"

Not null

Output:

Type

Description

Int

Returns the ProjectId, which is numeric and primary key in Digite.

3.4.5 UpdateProjectDetails ()

This API will update the project fields even if they are hidden in UI.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ExternalEmployeeId

String

Id of the user updating this project. ExternalEmployeeId passed in CreateUser method. If the ExternalEmployeeId is passed as null in the CreateUser method this field will accept the return value of the CreateUser method

Not null

2

ExternalProjectCode

String

Id of project to be updated. ExternalProjectCode passed in CreateProjectRegistration(), If passed null there then it will refer to digite's projectcode

Not null

3

ProjectName

String

Name of the Project

Not null

4

PlannedStartDate

String

Project planned start date

Not null

5

PlannedEndDate

String

Project planned End Date

Not null

6

Priority

String

Project Priority

Not null

7

ProjectManagerExternalEmployeeId

String

ExternalEmployeeId passed in CreateUser method. If the ExternalEmployeeId is passed as null in the CreateUser method this field will accept the return value of the CreateUser method

Not null

8

ClientName

String

 

Not null

9

Description

String

Project Description

Not null

10

CustFieldLabels

String[]

Array of custom field labels, which need to be updated. You can also pass ActualStartDate and ActualEndDate, Fields not passed should not be updated even if they are mandatory.

Null allowed

11

CustFieldValues

String[]

Array of custom field values, which will be set against the above specified labels.

Null allowed based on previous parameter

Output:

Type

Description

Void

Exception will be thrown in case of any error.

3.4.6 CloseProject ()

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ExternalEmployeeId

String

Id of the user closing the project. ExternalEmployeeId passed in CreateUser method. If the ExternalEmployeeId is passed as null in the CreateUser method this field will accept the return value of the CreateUser method

Not null

2

ExternalProjectCode

String

Id of project to be closed. ExternalProjectCode passed in CreateProjectRegistration(), If passed null there then it will refer to digite's projectcode

Not null

3

ActualStartDate

String

Actual Start Date of Project

Null allowed, If null don't update the current values

4

ActualEndDate

String

Actual End Date of Project

Null allowed, If null don't update the current values

5

ActualEffort

Int

Actual Effort in person months

If not available, you can specify 0. There is no business logic attached with this value at present.

6

Comments

String

Closing Comments if any

Null allowed, If null don't update the current values

Output:

Type

Description

Void

Exception will be thrown in case of any error.

3.4.7 RemoveProjectRelationshipToOrg ()

This API can be used to remove an existing relationship between project and an organization.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ExternalProjectCode

String

ExternalProjectCode passed in CreateProjectRegistration(), If passed null there then it will refer to digite's projectcode

Not null

2

ExternalOrgCode

String

ExternalOrgCode passed in CreateOrganization method. If the ExternalOrgCode is passed as null in the CreateOrganization method this field will accept the return value of the CreateOrganization method

Not null

3

RelationshipType

String

Org-Prj Relationship Name

Not null

Output:

Type

Description

Void

Exception will be thrown in case of any error.

3.5. Team Member Webservices

3.5.1 AddTeamMemberToProject ()

This API adds the specified team member to given project. Refer to input parameter list for more details.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ExternalProjectCode

String

ProjectCode passed in CreateProjectRegistration(), If passed null there then it will refer to digite's ProjectId (primary key)

Not null

2

ExternalEmployeeId

String

ExternalEmployeeId passed in CreateUser method. If the ExternalEmployeeId is passed as null in the CreateUser method this field will accept the return value of the CreateUser method

Not null

3

ProjectRoles

String[]

Array of Role names, already created in Project, to be assigned to team member

Not null

4

CustFieldLabels

String[]

Array of custom field labels present in team member eform, to be set.

Null allowed

5

CustFieldValues

String[]

Array of values for fields specified in the previous parameter.

Null allowed

6

StartDate

String

Allocation start date for the team members being added.

Not null

7

EndDate

String

Allocation end date for the team members being added.

Not null

8

PercentAlloc

Float

Percent allocation for the given allocation period

Not null

Output:

Type

Description

Int[]

Will return team member id at first index position and allocation Id at second index position, both ids are primary key in digite. Exception will be thrown in case of any error.

3.5.2 GetTeamMemberInfo ()

It retrieves the Team member information.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

TeamMemberId

Int

TeamMemberId returned by AddTeamMemberToProject method.

Not null

Output:

Type

Description

String

Will return the Team Member Info in the following XML format.

<TeamMembers>

<TeamMember>

<FieldName>FieldValue</FieldName>

</ TeamMember>

</TeamMembers>

Where FieldName is the label of the field that you will see on screen. Exception will be thrown in case of any error.

3.5.3 AssignRolesToTeamMember ()

It will clear all the previous roles and assign the new ones.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

TeamMemberId

Int

TeamMemberId returned by AddTeamMemberToProject method.

Not null

3

ProjectRoles

String[]

Array of Role names to be assigned to team member

Not null

Output:

Type

Description

Void

Exception will be thrown in case of any error.

3.5.4 AddTeamMembersToProjectInBulk ()

This API will add Team members in bulk. Since this is bulk update input data is accepted in the form of 1d and 2d arrays and hence the Index position will be used to extract related data from different parameters

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ExternalProjectCode

String

ProjectCode passed in CreateProjectRegistration(), If passed null there then it will refer to digite's projectcode

Not null

2

ExternalEmployeeIds

String[]

Array of User ids to be added to the project. ExternalEmployeeId passed in CreateUser method. If the ExternalEmployeeId is passed as null in the CreateUser method this field will accept the return value of the CreateUser method

Not null

3

ProjectRoles

String[][]

2D Array of Role names to be assigned to team member. First dimension index will be used to select the user id from the previous parameter.

Null allowed. If no role is specified, Template User's role will be used.

4

CustFieldLabels

String[][]

2D Array of custom field labels in team member eform. First dimension index will be used to identify User from "ExternalEmployeeId" parameter.

Not null

5

CustFieldValues

String[][]

2D Array of custom field values. First dimension index will be used to match with the previous parameter.

Not null

6

AllocationStartDates

String[]

Array of allocation start dates for the team members being added.

Not null

7

AllocationEndDates

String[]

Array of allocation end dates for the team members being added.

Not null

8

PercentAllocs

Float[]

Array of percent allocation for the given allocation period

Not null

Output:

Type

Description

String

The information of the added teammembers will be provided in the following XML output

<TeamMembers>

<TeamMember ExternalEmployeeId=''>

<TeamMemberId>Team Member Id</TeamMemberId>

<AllocationId>Allocation Id</AllocationId>

</TeamMember>

<TeamMember ExternalEmployeeId=''>

<TeamMemberId>Team Member Id</TeamMemberId>

<AllocationId>Allocation Id</AllocationId>

</TeamMember>

</TeamMembers>

The team member id and allocation Id are primary keys in digite. In case of error, not a single Team member will be added and Exception will be thrown.

3.5.5 UpdateTeamMemberDetailsInBulk ()

Since this is bulk update input data is accepted in the form of 1d and 2d arrays and hence the Index position will be used to extract related data from different parameters

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

TeamMemberIds

int[]

Array of Team member Ids of team members to be updated. TeamMemberId returned by AddTeamMemberToProject method.

Not null

2

CustFieldLabels

String[][]

2D Array of custom field labels in team member eform. First dimension index will be used to identify User from first parameter, Fields not passed should not be updated, even if they are mandatory.

Not null

3

CustFieldValues

String[][]

2D Array of custom field values. First dimension index will be used to match with the previous parameter.

Not null

Output:

Type

Description

Void

In case of any error not a single Team member details will be updated and Exception will be thrown.

3.5.6 DeleteTeamMembersFromProjectInBulk ()

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

TeamMemberIds

Int[]

Array of team member Ids to be deleted from project. TeamMemberId returned by AddTeamMemberToProject method.

Not null

Output:

Type

Description

Void

Exception will be thrown in case of any error.

3.5.7 UnAssignTeamMembersFromProjectInBulk ()

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

TeamMemberIds

Int[]

Array of team member Ids to be unassigned from project. TeamMemberId returned by AddTeamMemberToProject method.

Not null

2

IsForced

Boolean[]

Arrays of Booleans matching with previous parameter. If true ,unassign the team member even if there are open items on his/her name else if false, return error if there are open items assigned to team member.

Not null

Output:

Type

Description

Void

Exception will be thrown in case of any error.

3.5.8 ReAssignTeamMembersToProjectInBulk ()

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

TeamMemberIds

Int[]

Array of team member Ids to be reassigned to project. TeamMemberId returned by AddTeamMemberToProject method.

Not null

2

StartDates

String[]

New Start Dates. These dates will not be considered if UpdateExistingAllocations is set to true.

Null allowed

3

EndDates

String[]

New End Dates. New End dates for the allocations.

Not null

4

UpdateExistingAllocation

boolean

If this is set to true, then end date for the last allocation for the team member would be updated. If this is set to false, then new allocations will be created with specified start and end dates

Not null

Output:

Type

Description

String

Output XML format, returning new AllocationIds

<TeamMembers>

<TeamMember id=>AllocationId</TeamMember>

<TeamMember id=>AllocationId</TeamMember>

</TeamMembers>

Exception will be thrown in case of any error.

3.5.9 GetTeamMembersInfo ()

This API returns team member information for multiple users at one go.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

TeamMemberId

Int[]

Array of TeamMemberId returned by AddTeamMemberToProject method.

Not null

Output:

Type

Description

String

Will return the Team Members Info in the following XML format.

<TeamMembers>

<TeamMember id=>

<FieldName>FieldValue</FieldName>

</ TeamMember>

<TeamMember id=>

<FieldName>FieldValue</FieldName>

</ TeamMember>

</TeamMembers>

Where FieldName is the label of the field that you will see on screen and the id attribute is TeamMember id passed as input. Exception will be thrown in case of any error.

3.5.10 GetTeamMemberId ()

This method returns Digite's Team member Id, which is primary key in Digite for the given External Project and User id.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ExternalProjectCode

String

ProjectCode passed in CreateProjectRegistration(), If passed null there then it will refer to Digite's ProjectCode

Not null

2

ExternalEmployeeId

String

ExternalEmployeeId passed in CreateUser method. If the ExternalEmployeeId is passed as null in the CreateUser method this field will accept the return value of the CreateUser method

Not null

Output:

Type

Description

Int

Digite's internal Team member id. Exception will be thrown in case of any error.

3.6. Team Member Allocation Webservices

3.6.1 AddTeamMemberAllocation ()

It will add new allocation without affecting the current allocations.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

TeamMemberId

Int

TeamMemberId returned by AddTeamMemberToProject method.

Not null

3

StartDate

String

Start Date

Not null

4

EndDate

String

End Data

Not null

5

AllocationRoles

String[]

Array of Project Role names for the given allocation period

Null allowed

6

PercentAlloc

Float

Percentage allocation for the given period

Not null

Output:

Type

Description

Int

Will return AllocationId, which is primary key in digite. Exception will be thrown in case of any error.

3.6.2 AddBulkTeamMemberAllocation ()

It will add new allocation without affecting the current allocations in bulk mode.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

TeamMemberId

Int

TeamMemberId returned by AddTeamMemberToProject method.

Not null

3

StartDate

String[]

Start Dates

Not null

4

EndDate

String[]

End Dates

Not null

5

AllocationRoles

String[][]

Array of Project Role names for the given allocation periods

Null allowed

6

PercentAlloc

Float[]

Percentage allocation for the given period

Not null

Output:

Type

Description

String

Output XML format

<TeamMember>

<AllocationId StartDate=>AllocationId</AllocationId>

<AllocationId StratDate=>AllocationId</AllocationId>

</TeamMember>

Will return AllocationIds for all the added allocations in the above XML format where the order will match with the input StartDate array. However start date is also provided in as an attribute to the element. Exception will be thrown in case of any error with any allocation and no allocation will be added. So it is either all or none.

3.6.3 GetTeamMemberAllocationsInfo ()

As the name suggests, it returns the Information for all the allocations for a given team member.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

TeamMemberId

Int

TeamMemberId returned by AddTeamMemberToProject method.

Not null

Output:

Type

Description

String

Will return the Team Member Allocations Info in the following XML format.

<Allocations>

<Allocation Id=>

<StartDate>FieldValue</StartDate>

<EndDate>FieldValue</EndDate>

<PercentAlloc>FieldValue</PercentAlloc>

<Roles>

<RoleName>Value</RoleName>

</Roles>

</ Allocation>

</Allocations>

The "Id" attribute will contain Digite's Allocation Id for the allocation. Exception will be thrown in case of any error.

3.6.4 GetTeamMemberAllocationInfo ()

It returns the information about the given allocation for a team member.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

AllocationId

Int

Allocation Id, returned by AddTeamMemberAllocation

Not null

Output:

Type

Description

String

Will return the Team Member Allocation Info in the following XML format.

<Allocation>

<StartDate>FieldValue</StartDate>

<EndDate>FieldValue</EndDate>

<PercentAlloc>FieldValue</PercentAlloc>

<Roles>

<RoleName>Value</RoleName>

</Roles>

</ Allocation>

Exception will be thrown in case of any error.

3.6.5 UpdateTeamMemberAllocationsDetailsInBulk ()

It will update the existing allocations with the supplied inputs. Since this is bulk update input data is accepted in the form of 1d and 2d arrays and hence the Index position will be used to extract related data from different parameters.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

AllocationIds

Int[]

Arrays of allocation ids which are to be updated. Allocation Id, returned by AddTeamMemberAllocation

Not null

2

StartDates

String[]

New Start Dates

Not null

3

EndDates

String[]

New End Dates

Not null

4

PercentAllocs

Float[]

New Percentage allocations for the given period

Not null

Output:

Type

Description

Void

In case of any error not a single allocation will be updated and Exception will be thrown.

3.6.6 AssignRolesToTeamMemberAllocation ()

It will clear all the previous roles and assign new ones.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

AllocationId

Int

Allocation id, whose roles are to be modified. Allocation Id, returned by AddTeamMemberAllocation

Not null

2

AllocationRoles

String[]

New set of Roles for the given allocation Id. It will clear all the previous roles for the given allocation.

Not null

Output:

Type

Description

Void

In case of any error Exception will be thrown.

3.7. Generic Eform Services

3.7.1 CreateEformItemWithData ()

This API allows creation of an instance of any Eform item type in Digite for whom the Excel Import facility is provided in Digite UI. It also allows the workflow assignments.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

CreatorLoginId

String

Digite LoginId of the User creating this item instance.

Null allowed

2

OwnerType

String

Type of container in which this Item instance will be created. It can have either "Prj" for Project or "Org" for organization.

Not null

3

OwnerCode

String

Code of container in which this item is to be created. For Project it has to be project code, which is visible in Project Details screen as "Project Id" and for Organization it must be Organization code which is visible in Organization Details screen as "Id".

Not null

4

ItemType

String

Type of Eform, whose instance is to be created. Ex. For Defect you need to pass "Dft". The list of Eform types can be retrieved using Digite UI and referring to Eform list screen.

Not null

5

FieldLabels

String[]

Array of field labels, present in this eform template, which need to be set at creation.

Not null

6

FieldValues

String[]

Array of values for fields specified in the previous parameter.

Not null

7

Workflowstages

String[]

Array of Workflow stages, present in this eform template, which need to be assigned at creation.

Not null

8

WorkflowAssignments

String[]

Array of LoginIds of users to be assigned to workflow stages specified in the previous parameter.

Not null

Output:

Type

Description

Int

It will return an ItemId for the created item, which is primary key in Digite. Exception will be thrown in case of any error.

3.7.2 ModifyEformItem ()

This API updates the attributes of an existing Eform item instance along with the workflow assignments.

Note: for Axis2.x use "ModifyEformItemUsingItemCode" to call the WebService.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

CreatorLoginId

String

Digite LoginId of the User updating this item instance.

Null allowed

2

OwnerType

String

Type of container in which this Item instance exists. It can have either "Prj" for Project or "Org" for organization.

Not null

3

OwnerCode

String

Code of container in which this item exists. For Project it has to be project code, which is visible in Project Details screen as "Project Id" and for Organization it must be Organization code which is visible in Organization Details screen as "Id".

Not null

4

ItemType

String

Type of Eform, whose instance is to be modified. Ex. For Defect you need to pass "Dft". The list of Eform types can be retrieved using Digite UI and referring to Eform list screen.

Not null

5

ItemCode

String

Item Code of an Eform instance, which is to be updated.

 

6

FieldLabels

String[]

Array of field labels, present in this eform template, which need to be updated.

Not null

7

FieldValues

String[]

Array of values for fields specified in the previous parameter.

Not null

8

Workflowstages

String[]

Array of Workflow stages, present in this eform template, which need to be modified.

Not null

9

WorkflowAssignments

String[]

Array of LoginIds of users to be assigned to workflow stages specified in the previous parameter.

Not null

Output:

Type

Description

Int

It will return an ItemId of the modified item, which is primary key in Digite. Exception will be thrown in case of any error.

3.7.3 ModifyEformItem ()

This API updates the attributes of an existing Eform item instance along with the workflow assignments.

Note: for Axis2.x use "ModifyEformItemUsingItemId" to call the WebService.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

CreatorLoginId

String

Digite LoginId of the User updating this item instance.

Null allowed

2

OwnerType

String

Type of container in which this Item instance exists. It can have either "Prj" for Project or "Org" for organization.

Not null

3

OwnerCode

String

Code of container in which this item exists. For Project it has to be project code, which is visible in Project Details screen as "Project Id" and for Organization it must be Organization code which is visible in Organization Details screen as "Id".

Not null

4

ItemType

String

Type of Eform, whose instance is to be modified. Ex. For Defect you need to pass "Dft". The list of Eform types can be retrieved using Digite UI and referring to Eform list screen.

Not null

5

ItemId

Int

Id of an Eform instance, which is to be updated. This must be the value returned by API "CreateEformItemWithData", which is the primary key in Digite.

 

6

FieldLabels

String[]

Array of field labels, present in this eform template, which need to be updated.

Not null

7

FieldValues

String[]

Array of values for fields specified in the previous parameter.

Not null

8

Workflowstages

String[]

Array of Workflow stages, present in this eform template, which need to be modified.

Not null

9

WorkflowAssignments

String[]

Array of LoginIds of users to be assigned to workflow stages specified in the previous parameter.

Not null

Output:

Type

Description

Int

It will return an ItemId of the modified item, which is primary key in Digite. Exception will be thrown in case of any error.

3.7.4 DeleteEformItem ()

This API deletes an existing Eform item instance in the given container (Project or Organization).

Note: for Axis2.x use "DeleteEformItemUsingItemId" to call the WebService.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

CreatorLoginId

String

Digite LoginId of the User deleting this item instance.

Null allowed

2

OwnerType

String

Type of container in which this Item instance exists. It can have either "Prj" for Project or "Org" for organization.

Not null

3

OwnerCode

String

Code of container in which this item exists. For Project it has to be project code, which is visible in Project Details screen as "Project Id" and for Organization it must be Organization code which is visible in Organization Details screen as "Id".

Not null

4

ItemType

String

Type of Eform, whose instance is to be deleted. Ex. For Defect you need to pass "Dft". The list of Eform types can be retrieved using Digite UI and referring to Eform list screen.

Not null

5

ItemId

Int

Id of an Eform instance, which is to be deleted. This must be the value returned by API "CreateEformItemWithData", which is the primary key in Digite.

 

Output:

Type

Description

Void

 

3.7.5 DeleteEformItem ()

This API deletes an existing Eform item instance in the given container (Project or Organization).

Note: for Axis2.x use "DeleteEformItemUsingItemCode" to call the WebService.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

CreatorLoginId

String

Digite LoginId of the User deleting this item instance.

Null allowed

2

OwnerType

String

Type of container in which this Item instance exists. It can have either "Prj" for Project or "Org" for organization.

Not null

3

OwnerCode

String

Code of container in which this item exists. For Project it has to be project code, which is visible in Project Details screen as "Project Id" and for Organization it must be Organization code which is visible in Organization Details screen as "Id".

Not null

4

ItemType

String

Type of Eform, whose instance is to be deleted. Ex. For Defect you need to pass "Dft". The list of Eform types can be retrieved using Digite UI and referring to Eform list screen.

Not null

5

ItemCode

String

Item Code of an Eform instance, which is to be deleted.

 

Output:

Type

Description

Void

 

3.7.6 CloseEformItem ()

This API closes an existing Eform item instance in the given container (Project or Organization).

Note: for Axis2.x use "CloseEformItemUsingItemId" to call the WebService.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

CreatorLoginId

String

Digite LoginId of the User closing this item instance.

Null allowed

2

OwnerType

String

Type of container in which this Item instance exists. It can have either "Prj" for Project or "Org" for organization.

Not null

3

OwnerCode

String

Code of container in which this item exists. For Project it has to be project code, which is visible in Project Details screen as "Project Id" and for Organization it must be Organization code which is visible in Organization Details screen as "Id".

Not null

4

ItemType

String

Type of Eform, whose instance is to be closed. Ex. For Defect you need to pass "Dft". The list of Eform types can be retrieved using Digite UI and referring to Eform list screen.

Not null

5

ItemId

Int

Id of an Eform instance, which is to be closed. This must be the value returned by API "CreateEformItemWithData", which is the primary key in Digite.

 

Output:

Type

Description

Void

 

3.7.7 CloseEformItem ()

This API closes an existing Eform item instance in the given container (Project or Organization).

Note: for Axis2.x use "CloseEformItemUsingItemCode" to call the WebService.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

CreatorLoginId

String

Digite LoginId of the User closing this item instance.

Null allowed

2

OwnerType

String

Type of container in which this Item instance exists. It can have either "Prj" for Project or "Org" for organization.

Not null

3

OwnerCode

String

Code of container in which this item exists. For Project it has to be project code, which is visible in Project Details screen as "Project Id" and for Organization it must be Organization code which is visible in Organization Details screen as "Id".

Not null

4

ItemType

String

Type of Eform, whose instance is to be closed. Ex. For Defect you need to pass "Dft". The list of Eform types can be retrieved using Digite UI and referring to Eform list screen.

Not null

5

ItemCode

String

Item Code of an Eform instance, which is to be closed.

 

Output:

Type

Description

Void

 

3.7.8 getFieldValueBoolean ()

This API returns a value of an Eform item instance field, whose field data type is Boolean.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

OwnerType

String

Type of container in which this Item instance exists. It can have either "Prj" for Project or "Org" for organization.

Not null

2

OwnerID

String

This field can be one of the following:

⇒ If OwnerType passed as "Prj" then It must be Digite's ProjectId (primary key)

⇒ If OwnerType passed as "Org" then It must be Digite's OrganizationId (primary key)

Not null

3

ItemType

String

Type of Eform, whose field value is to be retrieved. Ex. For Defect you need to pass "Dft". The list of Eform types can be retrieved using Digite UI and referring to Eform list screen.

Not null

4

ItemID

Int

Id of an Eform instance, whose field value is to be retrieved. This must be the value returned by API "CreateEformItemWithData", which is the primary key in Digite.

Not null

5

FieldLabel

String

Label of the field whose value is to be retrieved.

Not null

Output:

Type

Description

Boolean

The value of the eform field for a given instance.

3.7.9 getFieldValueString ()

This API returns a value of an Eform item instance field, whose field data type is String.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

OwnerType

String

Type of container in which this Item instance exists. It can have either "Prj" for Project or "Org" for organization.

Not null

2

OwnerID

String

This field can be one of the following:

⇒ If OwnerType passed as "Prj" then It must be Digite's ProjectId (primary key)

⇒ If OwnerType passed as "Org" then It must be Digite's OrganizationId (primary key)

Not null

3

ItemType

String

Type of Eform, whose field value is to be retrieved. Ex. For Defect you need to pass "Dft". The list of Eform types can be retrieved using Digite UI and referring to Eform list screen.

Not null

4

ItemID

Int

Id of an Eform instance, whose field value is to be retrieved. This must be the value returned by API "CreateEformItemWithData", which is the primary key in Digite.

Not null

5

FieldLabel

String

Label of the field whose value is to be retrieved.

Not null

Output:

Type

Description

String

The value of the eform field for a given instance.

3.7.10 getFieldValueInt ()

This API returns a value of an Eform item instance field, whose field data type is integer.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

OwnerType

String

Type of container in which this Item instance exists. It can have either "Prj" for Project or "Org" for organization.

Not null

2

OwnerID

String

This field can be one of the following:

⇒ If OwnerType passed as "Prj" then It must be Digite's ProjectId (primary key)

⇒ If OwnerType passed as "Org" then It must be Digite's OrganizationId (primary key)

Not null

3

ItemType

String

Type of Eform, whose field value is to be retrieved. Ex. For Defect you need to pass "Dft". The list of Eform types can be retrieved using Digite UI and referring to Eform list screen.

Not null

4

ItemID

Int

Id of an Eform instance, whose field value is to be retrieved. This must be the value returned by API "CreateEformItemWithData", which is the primary key in Digite.

Not null

5

FieldLabel

String

Label of the field whose value is to be retrieved.

Not null

Output:

Type

Description

Int

The value of the eform field for a given instance.

3.7.11 getFieldValueFloat ()

This API returns a value of an Eform item instance field, whose field data type is float or numeric.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

OwnerType

String

Type of container in which this Item instance exists. It can have either "Prj" for Project or "Org" for organization.

Not null

2

OwnerID

String

This field can be one of the following:

⇒ If OwnerType passed as "Prj" then It must be Digite's ProjectId (primary key)

⇒ If OwnerType passed as "Org" then It must be Digite's OrganizationId (primary key)

Not null

3

ItemType

String

Type of Eform, whose field value is to be retrieved. Ex. For Defect you need to pass "Dft". The list of Eform types can be retrieved using Digite UI and referring to Eform list screen.

Not null

4

ItemID

Int

Id of an Eform instance, whose field value is to be retrieved. This must be the value returned by API "CreateEformItemWithData", which is the primary key in Digite.

Not null

5

FieldLabel

String

Label of the field whose value is to be retrieved.

Not null

Output:

Type

Description

Float

The value of the eform field for a given instance.

3.7.12 setFieldValueBoolean ()

This API sets the value of an Eform item instance field, whose field data type is Boolean.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

OwnerType

String

Type of container in which this Item instance exists. It can have either "Prj" for Project or "Org" for organization.

Not null

2

OwnerID

String

This field can be one of the following:

⇒ If OwnerType passed as "Prj" then It must be Digite's ProjectId (primary key)

⇒ If OwnerType passed as "Org" then It must be Digite's OrganizationId (primary key)

Not null

3

ItemType

String

Type of Eform, whose field value is to be set. Ex. For Defect you need to pass "Dft". The list of Eform types can be retrieved using Digite UI and referring to Eform list screen.

Not null

4

ItemID

Int

Id of an Eform instance, whose field value is to be set. This must be the value returned by API "CreateEformItemWithData", which is the primary key in Digite.

Not null

5

FieldLabel

String

Label of the field whose value is to be set.

Not null

6

FieldValue

Boolean

Value to be set on field

 

Output:

Type

Description

Void

 

3.7.13 setFieldValueString ()

This API sets the value of an Eform item instance field, whose field data type is String.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

OwnerType

String

Type of container in which this Item instance exists. It can have either "Prj" for Project or "Org" for organization.

Not null

2

OwnerID

String

This field can be one of the following:

⇒ If OwnerType passed as "Prj" then It must be Digite's ProjectId (primary key)

⇒ If OwnerType passed as "Org" then It must be Digite's OrganizationId (primary key)

Not null

3

ItemType

String

Type of Eform, whose field value is to be set. Ex. For Defect you need to pass "Dft". The list of Eform types can be retrieved using Digite UI and referring to Eform list screen.

Not null

4

ItemID

Int

Id of an Eform instance, whose field value is to be set. This must be the value returned by API "CreateEformItemWithData", which is the primary key in Digite.

Not null

5

FieldLabel

String

Label of the field whose value is to be set.

Not null

6

FieldValue

String

Value to be set on field

 

Output:

Type

Description

Void

 

3.7.14 setFieldValueInt ()

This API sets the value of an Eform item instance field, whose field data type is integer.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

OwnerType

String

Type of container in which this Item instance exists. It can have either "Prj" for Project or "Org" for organization.

Not null

2

OwnerID

String

This field can be one of the following:

⇒ If OwnerType passed as "Prj" then It must be Digite's ProjectId (primary key)

⇒ If OwnerType passed as "Org" then It must be Digite's OrganizationId (primary key)

Not null

3

ItemType

String

Type of Eform, whose field value is to be set. Ex. For Defect you need to pass "Dft". The list of Eform types can be retrieved using Digite UI and referring to Eform list screen.

Not null

4

ItemID

Int

Id of an Eform instance, whose field value is to be set. This must be the value returned by API "CreateEformItemWithData", which is the primary key in Digite.

Not null

5

FieldLabel

String

Label of the field whose value is to be set.

Not null

6

FieldValue

int

Value to be set on field

 

Output:

Type

Description

Void

 

3.7.15 setFieldValueFloat ()

This API sets the value of an Eform item instance field, whose field data type is numeric float.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

OwnerType

String

Type of container in which this Item instance exists. It can have either "Prj" for Project or "Org" for organization.

Not null

2

OwnerID

String

This field can be one of the following:

⇒ If OwnerType passed as "Prj" then It must be Digite's ProjectId (primary key)

⇒ If OwnerType passed as "Org" then It must be Digite's OrganizationId (primary key)

Not null

3

ItemType

String

Type of Eform, whose field value is to be set. Ex. For Defect you need to pass "Dft". The list of Eform types can be retrieved using Digite UI and referring to Eform list screen.

Not null

4

ItemID

Int

Id of an Eform instance, whose field value is to be set. This must be the value returned by API "CreateEformItemWithData", which is the primary key in Digite.

Not null

5

FieldLabel

String

Label of the field whose value is to be set.

Not null

6

FieldValue

float

Value to be set on field

 

Output:

Type

Description

Void

 

3.7.16 AddComments ()

This API allows adding comments an existing Eform item instance.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

OwnerType

String

Type of container in which this Item instance exists. It can have either "Prj" for Project or "Org" for organization.

Not null

2

OwnerID

String

This field can be one of the following:

⇒ If OwnerType passed as "Prj" then It must be Digite's ProjectId (primary key)

⇒ If OwnerType passed as "Org" then It must be Digite's OrganizationId (primary key)

Not null

3

ItemType

String

Type of Eform, to whom the comment is to be added. Ex. For Defect you need to pass "Dft". The list of Eform types can be retrieved using Digite UI and referring to Eform list screen.

Not null

4

ItemID

Int

Id of an Eform instance, to whom the comment is to be added. This must be the value returned by API "CreateEformItemWithData", which is the primary key in Digite.

Not null

5

Comment

String

Comment to be added to this eform instance.

Not null

6

LoggedBy

String

ExternalEmployeeId passed in CreateUser method. If the ExternalEmployeeId is passed as null in the CreateUser method this field will accept the return value of the CreateUser method. If it is passed as null, comments will be logged by System user.

Null allowed

Output:

Type

Description

Void

 

3.7.17 getEformItemStatus ()

This API returns the status of an Eform Item instance.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

OwnerType

String

Type of container in which this Item instance exists. It can have either "Prj" for Project or "Org" for organization.

Not null

2

OwnerID

String

This field can be one of the following:

⇒ If OwnerType passed as "Prj" then It must be Digite's ProjectId (primary key)

⇒ If OwnerType passed as "Org" then It must be Digite's OrganizationId (primary key)

Not null

3

ItemType

String

Type of Eform, whose status is to be retrieved. Ex. For Defect you need to pass "Dft". The list of Eform types can be retrieved using Digite UI and referring to Eform list screen.

Not null

4

ItemID

Int

Id of an Eform instance, whose status is to be retrieved. This must be the value returned by API "CreateEformItemWithData", which is the primary key in Digite.

Not null

 

Output:

Type

Description

String

Returns the Item status, It can one of "Open", "Closed", "Deleted".

3.7.18 AddActivityLog ()

It adds an activity log to the specified eform item instance. The log is shown as Created By a system user in Digite UI.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ItemType

String

Type of Eform, whose status is to be retrieved. Ex. For Defect you need to pass "Dft". The list of Eform types can be retrieved using Digite UI and referring to Eform list screen.

Not null

2

ItemID

Int

Id of an Eform instance, whose status is to be retrieved. This must be the value returned by API "CreateEformItemWithData", which is the primary key in Digite.

Not null

3

AuditLogComments

String

The log comments, which are to be added the eform instance

Not null

Output:

Type

Description

Void

 

3.7.19 GetCurrentWorkflowStageName ()

This API returns the name of current workflow stage of an Eform Item instance.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

OwnerType

String

Type of container in which this Item instance exists. It can have either "Prj" for Project or "Org" for organization.

Not null

2

OwnerID

String

This field can be one of the following:

⇒ If OwnerType passed as "Prj" then It must be Digite's ProjectId (primary key)

⇒ If OwnerType passed as "Org" then It must be Digite's OrganizationId (primary key)

Not null

3

ItemType

String

Type of Eform, whose current workflow stage is to be retrieved. Ex. For Defect you need to pass "Dft". The list of Eform types can be retrieved using Digite UI and referring to Eform list screen.

Not null

4

ItemID

Int

Id of an Eform instance, whose current workflow stage is to be retrieved. This must be the value returned by API "CreateEformItemWithData", which is the primary key in Digite.

Not null

Output:

Type

Description

String

Returns the name of the current workflow stage of the specified eform item.

3.7.20 SetTraceability ()

This API returns the name of current workflow stage of an Eform Item instance.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

FromOwnerType

String

OwnerType of the Item which needs to be traced

Not null

2

FromOwnerId

Int

OwnerId of the Item which needs to be traced

Not null

3

FromItemType

String

ItemType of the Item which needs to be traced

Not null

4

FromItemId

Int

ItemId of the Item which needs to be traced

Not null

5

ToOwnerType

String

OwnerType of the Item to which the item will be traced

Not null

6

ToOwnerId

Int

OwnerType of the Item to which the item will be traced

Not null

7

ToItemType

String

OwnerType of the Item to which the item will be traced

Not null

8

ToItemId

Int

OwnerType of the Item to which the item will be traced

Not null

Output:

Type

Description

   

3.7.21 RouteOrReject ()

This API returns the status of Item after Route/Reject Operation & Used to Route/Reject Item.

For Multiple Users case API needs to be called Multiple times. Ex. for two Mandatory Members API needs to be called 2 times with two user's UserId's & for One Mandatory & One Optional Member,Only Single call to API with Mandatory User's UserId will route item to next stage.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

OwnerType

String

OwnerType of the Item which needs to be routed

Not null

2

OwnerID

Int

OwnerId of the Item which needs to be routed

Not null

3

ItemType

String

ItemType of the Item which needs to be routed

Not null

4

ItemID

Int

ItemId of the Item which needs to be routed

Not null

5

userID

Int

UserId of User which who needs to route item

Not null

6

actionToPerform

String

Either Route/ Reject depending on item needs to be routed or rejected

Not null

7

comments

String

Routing Comments for Item..if Preference is on that Route/Reject Comments Required then this should not be null or blank

Null

 

Output:

Type

Description

String

Returns Status of Item after Route/Reject weather item is Open or Closed

3.8. Eclipse Integration Services

3.8.1 GetEformItemList ()

This API gets the list of the Items with the specified status and type from the specified Project

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

a_projectId

String

The ProjectId of the Project for which the items need to be brought

Null allowed

2

a_itemType

String

ItemType of the Item Project for which the items need to be brought

Null allowed

3

a_status

String

Status of the Items Project for which the items need to be brought

Null allowed

4

ItemType

String

ItemType of the Items Project for which the items need to be brought

Null allowed

Output:

Type

Description

String

Gives The List of the Items in the XML Format

3.8.2 GetProjectList ()

This API gets all the Projects which are opened and not under approval and for which the loggedIn user is invited in the project.

Input Parameters:

Sr. No.

Name

Type

Description

Validation

         

Output:

Type

Description

String

Gives The Project List in the XML Format

3.8.3 GetEformDetail ()

Input Parameters:

Sr. No.

Name

Type

Description

Validation

         

Output:

Type

Description

String

Gives The Project List in the XML Format

3.8.4 GetAttachmentContent ()

This method is used to get the attachment content of the attachementId passed

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

a_attachId

Integer

AttachmentId of the attachment for which content need to be brought

Not null

Output:

Type

Description

Byte[]

The content of the attachment in the byte[] format

3.8.5 GetEclipsePluginVersion ()

This method is used to get the eclipse version

Input Parameters:

Sr. No.

Name

Type

Description

Validation

         

Output:

Type

Description

String

Eclipse Plugin Version

3.8.6 GetLoggedInUserInfo ()

This method is used to get the LoggedIn User Details

Input Parameters:

Sr. No.

Name

Type

Description

Validation

         

Output:

Type

Description

String

User Info Details in XML Format

3.8.7 GetProjectInfo ()

This method is used to get the isDigiteStart and CheckedOutStatus of the Project

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

ProjectId

int

ProjectId of the Project for which info need to be brought

Not null

Output:

Type

Description

String[]

Gets the Project CheckedOut status and whether the Project is Digite Start or not

3.8.8 Logout ()

This method is used to logout from the system

Input Parameters:

Sr. No.

Name

Type

Description

Validation

         

Output:

Type

Description

boolean

Returns true if the logout is successful else false

3.8.9 AddAttachment ()

This method is used to add attachment to the Item

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

OwnerType

String

OwnerType of the Item to which the attachment is to be added

Not null

2

OwnerID

Integer

OwnerId of the Item to which the attachment is to be added

Not null

3

ItemType

String

Type of the Item to which the attachment is to be added

Not null

4

ItemID

Integer

Id of the Item to which the attachment is to be added

Not null

5

AttachmentFileName

String

Name of the file that needs to be added

Not null

6

AttachmentBytes

Byte[]

Content of the attachment

Not null

7

Description

String

Description Of the Attachment

Not null

Output:

Type

Description

Integer

Returns the AttachmentId of the attachment which is added

3.8.10 AddComments ()

This API is used to add comment to the Item

Input Parameters:

Sr. No.

Name

Type

Description

Validation

1

OwnerType

String

OwnerType of the Item to which the comments is to be added

Not null

2

OwnerID

Integer

OwnerId of the Item to which the comments is to be added

Not null

3

ItemType

String

Type of the Item to which the comments is to be added

Not null

4

ItemID

Integer

Id of the Item to which the comments is to be added

Not null

5

Comments

String

Content of the comment that needs to be added

Not null

Output:

Type

Description