public class TTBusObjService
extends java.lang.Object
All parameters are required unless (Optional) precedes the description.
The majority of the operations require an ID; some of the IDs are easy to obtain, some take more work. See Tips for Finding IDs for guidance.
The examples included are all run from with the SOAP UI tool. This tool is a quick and easy way to test individual SOAP calls against the Innotas Web Services. You can download this tool from www.soapUI.com.
In all cases, the parameters in the examples will need to be replaced with values from your instance.
The Admin/WebServices API page displays a list of web-service-enabled entities and their corresponding entity IDs, which are used with the API. In addition, every entity has a Fields link, which displays a list of all fields on an entity that can be accessed using the API. (If you do not see this page, then Web Services are not enabled for your organization and you should contact your Innotas Engagement Manager.)
Entities have fields, or attributes, associated with them. For example, a project entity might have fields like Title, Status, Owner, Start Date, Complete Date, plus many more. Each field, including user-defined fields (UDFs), is assigned a unique ID. You'll need to use these IDs to interact with Innotas programmatically through the API. Use the Fields function for an entity on Admin/Web Services API to display a dialog showing available fields for each entity state: select, insert, and update. The dialog also provides field IDs and an indication of which fields are required.
Once you have the entity ID, we recommend you call getEntityFields
to
get an accurate accounting of the fields on the entity. You can use this to
validate the field IDs you are using in the rest of your integration.
See the services.objects package for a list of the data objects and links to their descriptions.
Constructor and Description |
---|
TTBusObjService() |
Modifier and Type | Method and Description |
---|---|
TTAssociate[] |
addBasicAssociation(java.lang.String sessionId,
java.lang.Long sourceEntityTypeId,
java.lang.Long sourceEntityId,
java.lang.Long targetEntityTypeId,
java.lang.Long targetEntityId)
*
|
long |
allocateContour(java.lang.String sessionId,
java.lang.Long entityTypeId,
java.lang.Long entityId,
ContourEntry[] contourEntries)
Sets daily allocations for an allocated role (entity 54).
|
long |
allocateFinancialEntryContour(java.lang.String sessionId,
java.lang.Long entityTypeId,
java.lang.Long entityId,
FinancialEntryContourEntry[] contourEntries)
new method
|
java.lang.String |
allocateResourceTime(java.lang.String sessionId,
java.lang.Long[] taskIds,
java.lang.Long[] resourceIds,
java.lang.Long[] orgRoleIds,
java.lang.Float estimateHours,
java.lang.Float scheduleHours,
java.lang.Float percentOfTime,
java.lang.Float hoursToComplete)
Schedules one or more resource to one or more task.
|
java.lang.Boolean |
approveTimesheet(java.lang.String sessionId,
java.lang.Long timesheetId,
java.lang.Integer approvalLevel)
Approves a submitted Timesheet.
|
java.lang.Long |
assignEntityToRate(java.lang.String sessionId,
java.lang.Long entityTypeId,
java.lang.Long entityId,
java.lang.Long rateId,
java.lang.String effectiveDateString)
Associate resource or role to a shared rate table with a supplied effective date.
|
long[] |
copyTasks(java.lang.String sessionId,
java.lang.Long[] taskIds,
java.lang.Long targetEntityId,
java.lang.Long targetEntityTypeId,
java.lang.Boolean copySubtasks,
java.lang.Boolean copyTeam,
java.lang.Boolean copyExpenses,
java.lang.Boolean copySchedule,
java.lang.Boolean copyAttachments,
java.lang.Boolean copyNotes,
java.lang.Boolean preserveHierarchyStructure)
Copy one or more task from the one project to same or another project
|
java.lang.Long |
createCustomRateTable(java.lang.String sessionId,
java.lang.Long entityTypeId,
java.lang.Long entityId,
java.lang.String rateTitle,
java.lang.Double opexRate,
java.lang.Double capexRate,
java.lang.String effectiveDateString,
java.lang.String currencyCode)
This takes an entity type ID
ServiceConstants#ROLE or ServiceConstants#RESOURCE
and the ID of the entity and associates
it with a custom rate table (a rate table that is only for this resource/role). |
java.lang.String |
createOrReplace(java.lang.String sessionId,
EntityObj newObj,
ValuePair[] searchValuePairs)
Inserts or updates an entity.
|
java.lang.Long |
createOrReplaceMember(java.lang.String sessionId,
long parentTypeId,
long parentId,
long memberTypeId,
long memberInstanceId,
long profileId)
Ensures that one specific entity that is supported by enterprise permissions is shared with one specific member.
|
java.lang.Long |
createOrReplacePortfolio(java.lang.String sessionId,
java.lang.Long portfolioTypeId,
ValuePair[] valuePairs)
Creates or updates a Portfolio.
|
java.lang.Long |
createOrReplaceRequest(java.lang.String sessionId,
java.lang.Long requestTypeId,
ValuePair[] valuePairs)
Creates or updates a request.
|
ResourceProfileSetting[] |
createOrReplaceResourceProfileSetting(java.lang.String sessionId,
ResourceProfileSetting[] resourceProfileSettings)
Creates or replaces a resource's skills profile.
|
Timesheet[] |
createOrReplaceTimesheetEntries(java.lang.String sessionId,
Timesheet timesheet,
java.lang.Boolean autoSubmit,
java.lang.Boolean ignoreTSFilters,
java.lang.Boolean ignoreHTCUpdates)
Creates or replaces one or more timesheet entry in a timesheet.
|
Timesheet[] |
createOrReplaceTimesheets(java.lang.String sessionId,
Timesheet[] timesheets,
java.lang.Boolean autoSubmitAll,
java.lang.Boolean ignoreTSFilters,
java.lang.Boolean ignoreHTCUpdates)
Creates or replaces a set of timesheets.
|
java.lang.Long |
createProjectFromTemplate(java.lang.String sessionId,
java.lang.Long projectId,
java.lang.String title,
java.lang.Boolean copyTeam,
java.lang.Boolean copyAlertRoute,
java.lang.Boolean copyAllocation,
java.lang.Boolean copyScope,
java.lang.Boolean alertOnCopyScope,
java.lang.Boolean copySchedule,
java.lang.Boolean copyIssues,
java.lang.Boolean copyAttachments,
java.lang.Boolean copyCalendar,
java.lang.Boolean copyDashboardLinks,
java.lang.Boolean copyFinanceEntries,
java.lang.String scheduleFromDateYYYYMMDD)
Creates a project from a project template.
|
java.lang.Long |
createRate(java.lang.String sessionId,
java.lang.Long rateId,
java.lang.Double opexRate,
java.lang.Double capexRate,
java.lang.String effectiveDateString)
Once the Rate table has been created in
createRateTable(String, String, String, Double, Double, String)
additional Rates may be added to the table that will change the rate using the supplied effective date. |
java.lang.Long |
createRateTable(java.lang.String sessionId,
java.lang.String rateTitle,
java.lang.String rateDescription,
java.lang.Double opexRate,
java.lang.Double capexRate,
java.lang.String currencyCode)
Use this to create a shared rate table to be assigned to multiple Resources/Roles.
|
java.lang.Boolean |
deleteEntities(java.lang.String sessionId,
java.lang.Long entityTypeId,
java.lang.Long[] entityIds)
Deletes an array of entities.
|
java.lang.Boolean |
deleteEntity(java.lang.String sessionId,
java.lang.Long entityTypeId,
java.lang.Long entityId)
Deletes one specific entity.
|
java.lang.Boolean |
deleteMember(java.lang.String sessionId,
long parentTypeId,
long parentId,
long memberTypeId,
long memberInstanceId)
Removes one specific member from one specific entity that is supported by enterprise permissions.
|
java.lang.Boolean |
deleteTimesheetEntries(java.lang.String sessionId,
java.lang.Long timesheetId,
java.lang.Long[] timesheetEntryId)
Deletes one or more timesheet entries from a timesheet.
|
void |
destroy(ServiceContext serviceContext) |
EntityObj[] |
findEntity(java.lang.String sessionId,
java.lang.Long entityTypeId,
ValuePair[] searchValuePairs,
java.lang.Long[] fieldsRequest)
Returns one or more entities that match a set of criteria.
|
EntityHistoryObj[] |
findEntityUpdateHistory(java.lang.String sessionId,
java.lang.Long entityTypeId,
java.lang.String updatedFrom,
java.lang.String updatedTo,
ValuePair[] searchValuePairs,
java.lang.Long[] fieldsRequest)
*
|
TTAssociate[] |
getBasicAssociations(java.lang.String sessionId,
java.lang.Long sourceEntityTypeId,
java.lang.Long sourceEntityId,
java.lang.Long targetEntityTypeId)
*
|
Contour |
getContour(java.lang.String sessionId,
java.lang.Long entityTypeId,
java.lang.Long entityId,
java.lang.String startDate,
java.lang.String endDate)
Returns the contour for an allocated role or resource capacity for a specified date range.
|
DashboardMetadata |
getDashboardMetadata(java.lang.String sessionId,
long dashboardId)
Get the dashboard metadata for use with OData
|
EntityHistory[] |
getDeleteHistory(java.lang.String sessionId,
java.lang.Long entityTypeId,
java.lang.String startYYYYMMDD,
java.lang.String endYYYYMMDD,
java.lang.String simpleDateFormat)
Returns a list of entities of a specific type that were deleted during a given period.
|
EntityObj[] |
getEntitiesByFilter(java.lang.String sessionId,
java.lang.Long entityTypeId,
java.lang.String filter,
java.lang.Long[] fieldsRequest)
Selects one or more entities that match the filter criteria of the specified filter.
|
EntityHistoryObj[] |
getEntitiesByFilterUpdateHistory(java.lang.String sessionId,
java.lang.Long entityTypeId,
java.lang.String filter,
java.lang.String updatedFrom,
java.lang.String updatedTo,
java.lang.Long[] fieldsRequest)
Selects one or more entities that match the filter criteria of the specified filter within the date time window.
|
ObjectMethod[] |
getEntityFields(java.lang.String sessionId,
java.lang.Long entityTypeId,
java.lang.Long mode)
Returns a list of standard and UDF fields for an entity.
|
TTEntityNotes |
getEntityNotes(java.lang.String sessionId,
java.lang.Long entityTypeId,
java.lang.Long entityId,
java.lang.Long noteTypeId)
Returns all the notes or status commends that match the set of criteria
|
FinancialEntryContour |
getFinancialEntryContour(java.lang.String sessionId,
java.lang.Long entityTypeId,
java.lang.Long entityId,
java.lang.String startDate,
java.lang.String endDate)
Retrieves the Financial Entry contour between the optional start and end dates.
|
ValuePair[] |
getListValues(java.lang.String sessionId,
java.lang.Long fieldTypeId,
java.lang.Long fieldSubTypeId)
Returns ID-value pairs for entries for lookup and status lists in Innotas.
|
long |
getMemberId(java.lang.String sessionId,
long entityTypeId,
long entityInstanceId,
long resourceId)
Returns the member ID for a resource on a Portfolio or Asset team.
|
EntityObj[] |
getMembers(java.lang.String sessionId,
long parentTypeId,
long parentId)
Returns membership information on an entity supported by enterprise permissions.
|
java.lang.String |
getOdataUrl(java.lang.String sessionId,
long dashboardId)
Get the dashboard contents when dashboard is not running.
|
ObjectMethod[] |
getPortfolioFields(java.lang.String sessionId,
java.lang.Long portfolioTypeId)
Returns a list of fields associated with a Portfolio type.
|
ValuePair[] |
getPortfolioTypes(java.lang.String sessionId,
java.lang.String idOrTitle)
Returns portfolio type ID for a portfolio (portfolio types correspond to portfolio
categories in the Innotas app).
|
EntityObj[] |
getRate(java.lang.String sessionId,
java.lang.Long rateId)
Retrieves the rates for a supplied rate table ID.
|
EntityObj[] |
getRateTable(java.lang.String sessionId,
java.lang.Long[] rateId,
java.lang.String[] title)
Retrieves one or more rate tables that match any of the supplied Rate IDs or Titles.
|
ObjectMethod[] |
getRequestFields(java.lang.String sessionId,
java.lang.Long requestTypeId)
Returns a list of attributes (fields) associated with a Request Type.
|
ValuePair[] |
getRequestTypes(java.lang.String sessionId,
java.lang.String idOrTitle)
Returns a list of valid request type IDs.
|
ResourceProfileSetting[] |
getResourceProfileSetting(java.lang.String sessionId,
java.lang.Long[] resourceId)
Returns an array of objects representing one or more Resource's skills profile.
|
ProfileVariable[] |
getSkillCategories(java.lang.String sessionId)
Returns the values for each axis of the skills matrix configured for your organization.
|
long |
getTeamMemberId(java.lang.String sessionId,
long entityTypeId,
long entityInstanceId,
long resourceId)
Returns the team member ID for a resource on entities not supported by enterprise permissions.
|
Timesheet |
getTimesheet(java.lang.String sessionId,
long timesheetId)
Returns one Timesheet object that matches the specified timesheet ID.
|
Timesheet[] |
getTimesheetForUser(java.lang.String sessionId,
java.lang.Long userId,
java.lang.String startYYYYMMDD,
java.lang.String endYYYYMMDD)
Returns one or more Timesheet objects for the specified user ID.
|
Timesheet[] |
getTimesheetForUsers(java.lang.String sessionId,
java.lang.Long[] userIds,
java.lang.String startYYYYMMDD,
java.lang.String endYYYYMMDD)
Returns one or more Timesheet objects for each specified user ID.
|
Timesheet[] |
getTimesheets(java.lang.String sessionId,
java.lang.Long[] timesheetIds)
Returns an array of Timesheet objects that match the requested timesheet IDs.
|
TimesheetVariable[] |
getTimesheetVariables(java.lang.String sessionId,
java.lang.Long userId,
java.lang.Long periodId)
Deprecated.
Returns an array of TimesheetVariable objects for various Timesheet Entry Types.
TimesheetVariables are objects that contain the possible Project-Task-Role, Account-Program-Time-Type
and Other Non-Billable-Time-Type combinations required when creating Timesheet entries.
|
EntityHistory[] |
getUpdateHistory(java.lang.String sessionId,
java.lang.Long entityTypeId,
java.lang.String startYYYYMMDD,
java.lang.String endYYYYMMDD,
java.lang.Boolean showRepeatingPerDay,
java.lang.String simpleDateFormat)
Returns a list of entities of a specific type that were created, updated, or deleted during a given period.
|
TTAssociate[] |
getUpdateHistoryForBasicAssociations(java.lang.String sessionId,
java.lang.Long sourceEntityTypeId,
java.lang.Long targetEntityTypeId,
java.lang.String updatedFrom,
java.lang.String updatedTo,
java.lang.Boolean showRepeatingPerDay)
*
|
void |
init(ServiceContext serviceContext)
Session related methods
|
java.lang.Long |
insertEntity(java.lang.String sessionId,
java.lang.Long entityTypeId,
ValuePair[] valuePairs)
Creates a simple Innotas entity, such as a project, program, resource, account, task, and task schedule.
|
long |
insertNote(java.lang.String sessionId,
long parentEntityTypeId,
long parentId,
java.lang.String title,
java.lang.String content)
Creates a threaded note on the specified entity.
|
java.lang.String |
login(java.lang.String username,
java.lang.String password,
java.lang.Boolean sendAlerts)
Opens a session for a user and returns a session ID,
which is required for all subsequent method calls.
|
java.lang.Boolean |
logout(java.lang.String sessionId)
Logs out or closes a session.
|
boolean |
moveTasks(java.lang.String sessionId,
java.lang.Long targetEntityId,
java.lang.Long targetEntityTypeId,
java.lang.Long[] taskIds,
java.lang.Long positionAfterTaskId)
Moves tasks from one project to another, or moves tasks to a different parent in the current project.
|
java.lang.Boolean |
removeBasicAssociation(java.lang.String sessionId,
java.lang.Long sourceEntityTypeId,
java.lang.Long sourceEntityId,
java.lang.Long targetEntityTypeId,
java.lang.Long targetEntityId)
*
|
java.lang.String |
runDashboard(java.lang.String sessionId,
long dashboardId,
java.lang.String username,
java.lang.String token,
java.lang.String rerun)
Run the dashboard for later retrieval
|
TTAssociate[] |
selectBasicAssociations(java.lang.String sessionId,
java.lang.Long sourceEntityTypeId,
java.lang.Long sourceEntityId,
java.lang.Long targetEntityTypeId,
java.lang.Long targetEntityId)
*
|
EntityObj |
selectEntity(java.lang.String sessionId,
java.lang.Long entityTypeId,
java.lang.Long entityId,
java.lang.Long[] fieldsRequest)
Returns specific fields for an entity.
|
ServerInfoResponse |
serverInfo(java.lang.String login) |
java.lang.Boolean |
submitRequest(java.lang.String sessionId,
java.lang.Long requestId)
Submits the specified request to the first gate in the process for that request type.
|
java.lang.Boolean |
submitRequests(java.lang.String sessionId,
java.lang.Long[] requestIds)
Submits in-progess Requests to Gate 1.
|
java.lang.Boolean |
submitTimesheet(java.lang.String sessionId,
java.lang.Long timesheetId)
Submits a timesheet in progress.
|
java.lang.Boolean |
submitTimesheets(java.lang.String sessionId,
java.lang.Long[] timesheetIds)
Submits Timesheets in progress.
|
java.lang.Boolean |
updateAnEntityByMethodId(java.lang.String sessionId,
java.lang.Long entityTypeId,
java.lang.Long entityId,
java.lang.Long methodId,
java.lang.String methodValue)
Updates one field/method of an instance of an entity.
|
java.lang.Boolean |
updateEntity(java.lang.String sessionId,
java.lang.Long entityTypeId,
java.lang.Long entityId,
ValuePair[] valuePairs)
Updates one or more attributes (fields) of an entity.
|
java.lang.Boolean |
updateTimesheetEntries(java.lang.String sessionId,
TimesheetEntry[] timesheetEntries)
Updates one or more timesheet entries in a timesheet.
|
public java.lang.String login(java.lang.String username, java.lang.String password, java.lang.Boolean sendAlerts) throws AxisFault
A session is valid for 3 minutes, and resets with every call made within the 3 minute period. So if you get a session ID and make a few calls in a row you won't need another login call. But if you wait more than 3 minutes, you'll need to re-execute Login to get another session ID and use that in a subsequent call. OData users can also authenticate using this method. In this case, the username is not restricted to WSAPI users and the user's OAuth token should be sent as the password. A sessionId for an OData user is only valid for accessing the OData-related API calls (runDashboard, getOdataUrl, getDashboardMetadata)
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:login>
<ser:username>wsapi_user1</ser:username>
<ser:password>user1Password</ser:password>
</ser:login>
</soapenv:Body>
</soapenv:Envelope>
Response:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:loginResponse xmlns:ns="http://services">
<ns:return>16b74d98-9471-4276-be0c-13b3dbaa4fd1</ns:return> <--!SessionID-->
</ns:loginResponse>
</soapenv:Body>
</soapenv:Envelope>
username
- WSAPI user set up in Innotas. Must be WS API user type. This user type can access
Innotas using Web Services, and not by way of the web-based user interface.password
- Innotas password of the WSAPI user. Clear text (unencrypted).AxisFault
- when a user cannot be authenticated into Innotas or if a system error occurs.public java.lang.Boolean logout(java.lang.String sessionId) throws AxisFault
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:sessionId>16b74d98-9471-4276-be0c-13b3dbaa4fd1</ser:sessionId>
</ser:logout>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned from the Login operation.AxisFault
- caused by an Innotas system error.public ObjectMethod[] getEntityFields(java.lang.String sessionId, java.lang.Long entityTypeId, java.lang.Long mode) throws AxisFault
Example The following example gets all the fields required for an allocation (entity 54) in insert mode (mode 1).
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:getEntityFields>
<ser:sessionId>be9d3093-f6c0-4014-9f23-c6511afcd1fb</ser:sessionId>
<ser:entityTypeId>54</ser:entityTypeId> <--! allocation-->
<ser:mode>1</ser:mode> <--! insert mode-->
</ser:getEntityFields>
</soapenv:Body>
</soapenv:Envelope>
Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:getEntityFieldsResponse xmlns:ns="http://services" xmlns:ax21="http://objects.services/xsd">
<ns:return xsi:type="ax21:ObjectMethod" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:defaultValue xsi:nil="true"/>
<ax21:fieldLength>10</ax21:fieldLength>
<ax21:fieldSubTypeId>84</ax21:fieldSubTypeId>
<ax21:fieldTypeId>44</ax21:fieldTypeId>
<ax21:isRequired>false</ax21:isRequired>
<ax21:label>Bill Rate</ax21:label>
<ax21:method>billingRateId</ax21:method>
<ax21:methodId>5404</ax21:methodId>
<ax21:onInsert>true</ax21:onInsert>
<ax21:onSelect>true</ax21:onSelect>
<ax21:onUpdate>true</ax21:onUpdate>
<ax21:sequence>0</ax21:sequence>
</ns:return>
<ns:return xsi:type="ax21:ObjectMethod" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:defaultValue xsi:nil="true"/>
<ax21:fieldLength>20</ax21:fieldLength>
<ax21:fieldSubTypeId>0</ax21:fieldSubTypeId>
<ax21:fieldTypeId>8</ax21:fieldTypeId>
<ax21:isRequired>true</ax21:isRequired>
<ax21:label>End Date</ax21:label>
<ax21:method>endDate</ax21:method>
<ax21:methodId>5405</ax21:methodId>
<ax21:onInsert>true</ax21:onInsert>
<ax21:onSelect>true</ax21:onSelect>
<ax21:onUpdate>true</ax21:onUpdate>
<ax21:sequence>0</ax21:sequence>
</ns:return>
...
</ns:getEntityFieldsResponse>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.entityTypeId
- The ID of the entity type you are working with. For example, 5 for project, 4 for tasks, and so on.
See the Admin>Web Services API page in the Innotas application for the list of supported Entity Types and their corresponding IDs.mode
- The "state" of the entity. 1 = insert , 2 = update, 3 = select, 0 = all. The default value is 0, which returns
all fields.AxisFault
- thrown when the session ID is invalid or if an invalid entity type is used.public TTEntityNotes getEntityNotes(java.lang.String sessionId, java.lang.Long entityTypeId, java.lang.Long entityId, java.lang.Long noteTypeId) throws AxisFault
Example
The example below searches for one project and returns all the notes in it.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services" xmlns:xsd="http://objects.services/xsd">
<soapenv:Header/>
<soapenv:Body>
<ser:getEntityNotes>
<ser:sessionId>91253ba1-ee1e-4fbd-8eb6-26ecddb3cb44</ser:sessionId>
<ser:entityTypeId>4</ser:entityTypeId>
<ser:entityId>1638654057</ser:entityId>
<ser:noteTypeId>65</ser:noteTypeId>
</ser:getEntityNotes>
</soapenv:Body>
</soapenv:Envelope>
Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:getEntityNotesResponse xmlns:ns="http://services" xmlns:ax21="http://objects.services/xsd">
<ns:return xsi:type="ax21:EntityObj" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:entityTypeId>4</ax21:entityTypeId>
<ax21:entityId>1638654057</ax21:entityId>
<ax21:noteTypeId>65</ax21:noteTypeId>
<ax21:Note xsi:type="ax21:Note">
<ax21:id>XXXX</ax21:id>
<ax21:title>Top level Note 1</ax21:title>
<ax21:parentId>XXXX{ProjectId}</ax21:parentId>
<ax21:content>Test content</ax21:content>
<ax21:author>User,Admin</ax21:author>
<ax21:createDate>2016-02-10T17:11:38Z</ax21:createDate>
<ax21:modifyDate>2016-02-10T17:11:38Z</ax21:modifyDate>
<ax21:Note xsi:type="ax21:Note">
<ax21:id>XXXX</ax21:id>
<ax21:title>Reply Note 1</ax21:title>
<ax21:parentId>XXXX{parent note Id}</ax21:parentId>
<ax21:content>Test content</ax21:content>
<ax21:author>User,Admin</ax21:author>
<ax21:createDate>2016-02-10T17:11:38Z</ax21:createDate>
<ax21:modifyDate>2016-02-10T17:11:38Z</ax21:modifyDate>
</ax21:Note>
<ax21:Note xsi:type="ax21:Note">
<ax21:id>XXXX</ax21:id>
<ax21:title>Reply Note 2</ax21:title>
<ax21:parentId>XXXX{parent note Id}</ax21:parentId>
<ax21:content>Test content</ax21:content>
<ax21:author>User,Admin</ax21:author>
<ax21:createDate>2016-02-10T17:11:38Z</ax21:createDate>
<ax21:modifyDate>2016-02-10T17:11:38Z</ax21:modifyDate>
<ax21:Note xsi:type="ax21:Note">
<ax21:id>XXXX</ax21:id>
<ax21:title>Reply to Reply Note 2</ax21:title>
<ax21:parentId>XXXX{parent note Id}</ax21:parentId>
<ax21:content>Test content</ax21:content>
<ax21:author>User,Admin</ax21:author>
<ax21:createDate>2016-02-10T17:11:38Z</ax21:createDate>
<ax21:modifyDate>2016-02-10T17:11:38Z</ax21:modifyDate>
</ax21:Note>
</ax21:Note>
</ax21:Note>
<ax21:Note xsi:type="ax21:Note">
<ax21:id>XXXX</ax21:id>
<ax21:title>Top level Note 2</ax21:title>
<ax21:parentId>XXXX{ProjectId Id}</ax21:parentId>
<ax21:content>Test content</ax21:content>
<ax21:author>User,Admin</ax21:author>
<ax21:createDate>2016-02-10T17:11:38Z</ax21:createDate>
<ax21:modifyDate>2016-02-10T17:11:38Z</ax21:modifyDate>
</ax21:Note>
</ns:return>
</ns:getEntityNotes>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.entityTypeId
- The ID of the entity type you are working with. You can find the IDs in the Innotas app on Admin/Web Services API.entityId
- The ID for the entity associated to the notesnoteTypeId
- Specifies whether we are looking for notes or status commentsAxisFault
- when the session is invalid, if an entity cannot be found, or if a system error occurred.public ValuePair[] getListValues(java.lang.String sessionId, java.lang.Long fieldTypeId, java.lang.Long fieldSubTypeId) throws AxisFault
The most commonly used field types are:
If you need to retrieve the descriptions, use selectEntity and findEntity.
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:getListValues>
<ser:sessionId>c4ea1a07-4619-4727-93e5-46d3714a7f97</ser:sessionId>
<ser:fieldTypeId>14</ser:fieldTypeId> <!--Status List field type -->
<ser:fieldSubTypeId>10</ser:fieldSubTypeId> <!-- Project status list -->
</ser:getListValues>
</soapenv:Body>
</soapenv:Envelope>
Response:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:getListValuesResponse xmlns:ns="http://services" xmlns:ax21="http://objects.services/xsd">
<ns:return xsi:type="ax21:ValuePair" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:elementValue>Proposed</ax21:elementValue>
<ax21:id>8827183</ax21:id>
</ns:return>
<ns:return xsi:type="ax21:ValuePair" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:elementValue>Open</ax21:elementValue>
<ax21:id>8827184</ax21:id>
</ns:return>
<ns:return xsi:type="ax21:ValuePair" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:elementValue>Hold</ax21:elementValue>
<ax21:id>8827185</ax21:id>
</ns:return>
<ns:return xsi:type="ax21:ValuePair" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:elementValue>Closed</ax21:elementValue>
<ax21:id>8827186</ax21:id>
</ns:return>
<ns:return xsi:type="ax21:ValuePair" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:elementValue>$Template</ax21:elementValue>
<ax21:id>9611632</ax21:id>
</ns:return>
</ns:getListValuesResponse>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.fieldTypeId
- Integer representing the type of field, such as Lookup List, Status list, and so on.
Every field type has an associated ID.fieldSubTypeId
- The ID of the instance of the field type. For example, the Project Status
lookup list has an ID of 10.AxisFault
- thrown when the session ID is invalid or if the lookup or status list cannot be located.public ProfileVariable[] getSkillCategories(java.lang.String sessionId) throws AxisFault
ProfileVariable
for an example of the return object.sessionId
- The Session ID string returned by the Login operation.AxisFault
- thrown when the session ID is invalid or if profiles cannot be located.public TimesheetVariable[] getTimesheetVariables(java.lang.String sessionId, java.lang.Long userId, java.lang.Long periodId) throws AxisFault
sessionId
- The Session ID string returned by the Login operation.userId
- The Innotas user ID for the resource associated with the timesheet.periodId
- Timesheet Period ID associated with the Timesheet ID.AxisFault
- thrown when session ID is invalid or a Resource and/or Period is invalid.public Timesheet[] getTimesheetForUser(java.lang.String sessionId, java.lang.Long userId, java.lang.String startYYYYMMDD, java.lang.String endYYYYMMDD) throws AxisFault
sessionId
- The Session ID string returned by the Login operation.userId
- The Innotas resource ID.startYYYYMMDD
- A string representation of a start date in the form Year/Month/Day.
For example: 11 January 2001 is 2001/01/11. If specified, returns all timesheets from start date
to the end date, if specified.
If the period is invalid, returns current timesheet.endYYYYMMDD
- A string representation of an end date in the form Year/Month/Day.
For example: 11 January 2001 is 2001/01/11. If no end date is specified, current date is used as
end date; best practice is to use end date.AxisFault
- when the session ID is invalid or if timesheets cannot be retrieved.public Timesheet[] getTimesheetForUsers(java.lang.String sessionId, java.lang.Long[] userIds, java.lang.String startYYYYMMDD, java.lang.String endYYYYMMDD) throws AxisFault
sessionId
- The Session ID string returned by the Login operation.userIds
- Array of Innotas resource IDs.startYYYYMMDD
- A string representation of a start date in the form Year/Month/Day.
For example: 11 January 2001 is 2001/01/11. If specified, returns all timesheets from start date.
If the period is invalid, returns current timesheet.endYYYYMMDD
- A string representation of an end date in the form Year/Month/Day.
For example: 11 January 2001 is 2001/01/11. If no end date is specified, current date is used as end date; best
practice is to use end date.AxisFault
- when the session ID is invalid or if timesheets cannot be retrieved.public Timesheet getTimesheet(java.lang.String sessionId, long timesheetId) throws AxisFault
sessionId
- The Session ID string returned by the Login operation.timesheetId
- Innotas Timesheet ID.AxisFault
- when the session ID is invalid or if timesheet cannot be
retrieved.public Timesheet[] getTimesheets(java.lang.String sessionId, java.lang.Long[] timesheetIds) throws AxisFault
sessionId
- The Session ID string returned by the Login operation.timesheetIds
- Array of Innotas Timesheet IDs.AxisFault
- when the session ID is invalid or if the timesheet(s) cannot be retrieved.public Timesheet[] createOrReplaceTimesheetEntries(java.lang.String sessionId, Timesheet timesheet, java.lang.Boolean autoSubmit, java.lang.Boolean ignoreTSFilters, java.lang.Boolean ignoreHTCUpdates) throws AxisFault
TimesheetEntry
, for example, to add multiple timesheet entries
to a user's timesheet for a given week.
If there is no entry for the specified day, then a new entry is created. If an entry exists for the specified day, it is updated. If you send in 0 hours, the entry is deleted.
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services" xmlns:xsd="http://objects.services/xsd">
<soapenv:Header/>
<soapenv:Body>
<ser:createOrReplaceTimesheetEntries>
<ser:sessionId>5A3F7A5472964DC5D53C046F699C4318</ser:sessionId>
<ser:timesheet>
<xsd:entriesProject>
<xsd:entryDate>2011/05/25</xsd:entryDate>
<xsd:entryHours>2.0</xsd:entryHours>
<xsd:entryTypeId>1</xsd:entryTypeId> <!--entry type 1 = Project time-->
<xsd:level1Id>206746294</xsd:level1Id> <!--Project ID-->
<xsd:level2Id>206746674</xsd:level2Id> <!--Task ID-->
<xsd:level3Id>206746913</xsd:level3Id> <!--Org Role ID-->
</xsd:entriesProject>
<xsd:timesheetId>368966538</xsd:timesheetId>
</ser:timesheet>
</ser:createOrReplaceTimesheetEntries>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.timesheet
- Timesheet object that contains Project, Account and other entry information to create and/or submit.autoSubmit
- Set to True to automatically submit a timesheet to the first approval level when
it is created. Set to False if no submit needs to happen; the
timesheet remains in progress state. Default is False.ignoreTSFilters
- set to true for ignore Timesheet Filter Rules. Default is False.ignoreHTCUpdates
- set to true for ignore updation of HTC. Default is False.AxisFault
- when the session ID is invalid or if timesheet entry cannot be processed.public Timesheet[] createOrReplaceTimesheets(java.lang.String sessionId, Timesheet[] timesheets, java.lang.Boolean autoSubmitAll, java.lang.Boolean ignoreTSFilters, java.lang.Boolean ignoreHTCUpdates) throws AxisFault
Timesheet
object contains one or more entries that
correspond to Project, Account, Portfolio, or Administrative (other) time.
If you pass in a timesheet ID, it will search for the ID and if it does not exist, create a new timesheet.
Example
The following is a partial example of one timesheet that includes an Account entry and a partial Administrative (other) entry. You would repeat the "timesheets" wrapper if you wanted to create more than one timesheet. Each wrapper would contain one or more "entries".
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services" xmlns:xsd="http://objects.services/xsd">
<soapenv:Header/>
<soapenv:Body>
<ser:createOrReplaceTimesheets>
<ser:sessionId>?</ser:sessionId>
<ser:timesheets>
<xsd:endDate>2014/02/02</xsd:endDate?
<xsd:entriesOther>
<xsd:billableRate>0.0</xsd:billableRate>
<xsd:companyId>0</xsd:companyId>
<xsd:entryDate>2014/01/27</xsd:entryDate>
<xsd:entryHours>8.0</xsd:entryHours>
<xsd:entryId>1163233640</xsd:entryId>
<xsd:entryTypeId>2</xsd:entryTypeId>
<xsd:internalRate>100.0</xsd:internalRate>
<xsd:isBillable>false</xsd:isBillable>
<xsd:isProductive>false</xsd:isProductive>
<xsd:level1Id>0</xsd:level1Id>
<xsd:level2Id>0</xsd:level2Id>
<xsd:level3Id>5</xsd:level3Id>
<xsd:locationId>0</xsd:locationId>
<xsd:notes>Selected to Jury.</xsd:notes>
<xsd:state>Started</xsd:state>
<xsd:timesheetId>812598409</xsd:timesheetId>
</xsd:entriesOther>
<xsd:entriesProject>
<xsd:billableRate>150.0</xsd:billableRate>
<xsd:companyId>0</xsd:companyId>
...
<xsd:startDate>2014/01/27</xsd:startDate>
<xsd:summaryNotes>Need to find a resource to fill in during Jury Duty.</xsd:summaryNotes>
<xsd:timesheetId>812498409</xsd:timesheetId>
<xsd:timesheetPeriodId>11436618</xsd:timesheetPeriodId>
<xsd:userId>8826911</xsd:userId>
</ser:timesheets>
<ser:autoSubmitAll>true</ser:autoSubmitAll>
</ser:createOrReplaceTimesheets>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.timesheets
- Array of Timesheet objects that contain Project, Account, Portfolio, or Administrative (other)
entries to create and/or submit.autoSubmitAll
- Set to True to automatically submit timesheets to the first approval level after
they are created with this operation. Set to False if no submit needs to happen; the
timesheet remains in progress state. Default is False.ignoreTSFilters
- set to true for ignore Timesheet Filter Rules. Default is False.ignoreHTCUpdates
- set to true for ignore updation of HTC. Default is False.AxisFault
- when the session Id is invalid or if timesheet entry cannot be processed.public java.lang.Boolean updateTimesheetEntries(java.lang.String sessionId, TimesheetEntry[] timesheetEntries) throws AxisFault
sessionId
- The Session ID string returned by the Login operation.timesheetEntries
- An array of TimesheetEntry objects with updated values. A timesheet entry is a record
that contains Project, Account, Portfolio, Administrative info.AxisFault
- when the session ID is invalid or if the timesheet entry cannot be retrieved or updated.public java.lang.Boolean deleteTimesheetEntries(java.lang.String sessionId, java.lang.Long timesheetId, java.lang.Long[] timesheetEntryId) throws AxisFault
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:deleteTimesheetEntries>
<ser:sessionId>6348dc07-3f2e-4e2f-90f8-bc2b8d2c39da</ser:sessionId>
<ser:timesheetId>1163155163</ser:timesheetId>
<!--Zero or more repetitions:-->
<ser:timesheetEntryId>85687839</ser:timesheetEntryId>
</ser:deleteTimesheetEntries>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.timesheetId
- The Innotas timesheet ID of the timesheet from which to delete the entry(ies).timesheetEntryId
- An array of Innotas timesheet entry IDs to delete.AxisFault
- when the session is invalid ID or if timesheet entry cannot be retrieved or deleted.public java.lang.Boolean submitTimesheet(java.lang.String sessionId, java.lang.Long timesheetId) throws AxisFault
sessionId
- The Session ID string returned by the Login operation.timesheetId
- An Innotas timesheet ID specifying the timesheet to submit.AxisFault
- thrown when the session ID is invalid or if timesheet cannot be submitted.public java.lang.Boolean submitTimesheets(java.lang.String sessionId, java.lang.Long[] timesheetIds) throws AxisFault
sessionId
- The Session ID string returned by the Login operation.timesheetIds
- An array of Innotas timesheet IDs specifying the timesheets to submit.AxisFault
- thrown when the session ID is invalid or if a timesheet cannot be submitted.public java.lang.Boolean approveTimesheet(java.lang.String sessionId, java.lang.Long timesheetId, java.lang.Integer approvalLevel) throws AxisFault
getTimesheetForUser
, or,
in the Innotas application, open the timesheet and get the ID from the timesheet URL.
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:approveTimesheet>
<ser:sessionId>45310756-6810-4bed-8d21-c491675c2fa6</ser:sessionId>
<ser:timesheetId>812621222</ser:timesheetId>
<ser:approvalLevel>1</ser:approvalLevel>
</ser:approveTimesheet>
</soapenv:Body>
</soapenv:Envelope>
Response:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:approveTimesheetResponse xmlns:ns="http://services">
<ns:return>true</ns:return>
</ns:approveTimesheetResponse>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.timesheetId
- Innotas Timesheet ID specifying the timesheet to approve.approvalLevel
- 1 = PM Approve level only, 2 = Final Approve level only, 3 = Approve at both levelsAxisFault
- thrown when the session ID is invalid or if timesheet cannot be approved.public java.lang.Long createProjectFromTemplate(java.lang.String sessionId, java.lang.Long projectId, java.lang.String title, java.lang.Boolean copyTeam, java.lang.Boolean copyAlertRoute, java.lang.Boolean copyAllocation, java.lang.Boolean copyScope, java.lang.Boolean alertOnCopyScope, java.lang.Boolean copySchedule, java.lang.Boolean copyIssues, java.lang.Boolean copyAttachments, java.lang.Boolean copyCalendar, java.lang.Boolean copyDashboardLinks, java.lang.Boolean copyFinanceEntries, java.lang.String scheduleFromDateYYYYMMDD) throws AxisFault
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:createProjectFromTemplate>
<ser:sessionId>45360a69-9062-448c-9c88-17b400d75c7c</ser:sessionId>
<ser:projectId>73418480</ser:projectId>
<ser:title>My Project From Template</ser:title>
<ser:copyTeam>true</ser:copyTeam>
<ser:copyAllocation>true</ser:copyAllocation>
<ser:copyScope>true</ser:copyScope>
<ser:alertOnCopyScope>false</ser:alertOnCopyScope>
<ser:copySchedule>true</ser:copySchedule>
<ser:copyAttachments>false</ser:copyAttachments>
<ser:copyCalendar>false</ser:copyCalendar>
<ser:copyDashboardLinks>false</ser:copyDashboardLinks>
<ser:scheduleFromDateYYYYMMDD>2104/06/15</ser:scheduleFromDateYYYYMMDD>
</ser:createProjectFromTemplate>
</soapenv:Body>
</soapenv:Envelope>
Response:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:createProjectFromTemplateResponse xmlns:ns="http://services">
<ns:return>1163380744</ns:return>
</ns:createProjectFromTemplateResponse>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.projectId
- The project Id for the template project.title
- The title of the project being created.copyTeam
- True or False. Copies project team members to the new project.copyAlertRoute
- True or False. Copies project alert route to the new project.copyAllocation
- True or False. Copies team member roles over to new project (only effective if copyTeam = 'True').copyScope
- True or False. Copies tasks over to the new project.alertOnCopyScope
- True or False. Send emails out after tasks have been copied (only effective if copyScope ='True').copySchedule
- True or False. Copies task schedules (only effective if copyScope = 'True' and copyAllocation = 'True').copyAttachments
- True or False. Copies attachments.copyCalendar
- True or False. Copies project calendar or creates a new one for the new project
(based on the organization's default calendar).copyDashboardLinks
- True or False. Copies Dashboard links.copyFinanceEntries
- True or False. Copies Forecast Finance Emtores.scheduleFromDateYYYYMMDD
- Sets the scheduleFromDate for the new project. If no date is specified, uses today's date.AxisFault
- AxisFault if the source project cannot be found, or if a project with the name title
already exists.public ResourceProfileSetting[] getResourceProfileSetting(java.lang.String sessionId, java.lang.Long[] resourceId) throws AxisFault
sessionId
- The Session ID string returned by the Login operation.resourceId
- Array of Resource IDs representing the resource profiles to retrieve.AxisFault
- thrown when the session ID is invalid or if unable to locate one or more profile.public ResourceProfileSetting[] createOrReplaceResourceProfileSetting(java.lang.String sessionId, ResourceProfileSetting[] resourceProfileSettings) throws AxisFault
getResourceProfileSetting
to get the IDs for the existing profile. getSkillCategories
to get the values for the IDs. For example, getResourceProfileSettings
might return a categoryID = 882619. getSkillCategories will map that ID to the value "Applications".Example
The following example updates an existing resource skills profile. Note that if you are creating a new resource profile, the profileSettingId will be null.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services" xmlns:xsd="http://objects.services/xsd">
<soapenv:Header/>
<soapenv:Body>
<ser:createOrReplaceResourceProfileSetting>
<ser:sessionId>?</ser:sessionId>
<ser:resourceProfileSettings>
<!--One or more repetitions:-->
<xsd:profileSetting>
<xsd:categoryId>8826919</xsd:categoryId>
<xsd:profileSettingId>1163103785</xsd:profileSettingId>
<xsd:rangeValueId>8826922</xsd:rangeValueId>
<xsd:subCategoryId>8826924</xsd:subCategoryId>
</xsd:profileSetting>
<xsd:profileSetting>
<xsd:categoryId>8826919</xsd:categoryId>
<xsd:profileSettingId>1163103786</xsd:profileSettingId>
<xsd:rangeValueId>8826921</xsd:rangeValueId>
<xsd:subCategoryId>8826925</xsd:subCategoryId>
</xsd:profileSetting>
</ser:resourceProfileSettings>
</ser:createOrReplaceResourceProfileSetting>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.resourceProfileSettings
- ProfileSetting[] containing the settings to create or replace.AxisFault
- when the session ID is invalid or if unable to create one or more profile.public java.lang.Long insertEntity(java.lang.String sessionId, java.lang.Long entityTypeId, ValuePair[] valuePairs) throws AxisFault
For creating task schedules, note the following:
sessionId
- The Session ID string returned by the Login operation.entityTypeId
- The ID of the entity type you are working with. You can find the IDs in the Innotas app on Admin/Web Services API.valuePairs
- An array of methodId-value pairs that specify the fields and values to create for on the entity.AxisFault
- thrown if the session ID is invalid or if an Entity Type is not supported or a system error occured.createOrReplace(String, EntityObj[]) createOrReplace (create/replace multiple Objects)
,
createOrReplace(String, EntityObj, ValuePair[]) createOrReplace (create/replace a single Object)
public java.lang.Boolean updateEntity(java.lang.String sessionId, java.lang.Long entityTypeId, java.lang.Long entityId, ValuePair[] valuePairs) throws AxisFault
sessionId
- The Session ID string returned by the Login operation.entityTypeId
- The ID of the entity type you are working with. You can find the IDs in the Innotas app on Admin/Web Services API.entityId
- The unique ID of the instance of the entity type to update. You can find this ID on the Info page of the
entity (Resource Info, Project Info, and so on), or you can run a report.valuePairs
- An array of methodId-value pairs that specify the fields and values to create for on the entity.AxisFault
- thrown when the session is invalid or if an Entity Type is not supported or a system error occured.createOrReplace(String, EntityObj[]) createOrReplace (create/replace multiple Objects)
,
createOrReplace(String, EntityObj, ValuePair[]) createOrReplace (create/replace a single Object)
,
updateAnEntityByMethodId(String, Long, Long, Long, String) updateAnEntityByMethodId (update one attribute of specific entity)
public java.lang.Boolean updateAnEntityByMethodId(java.lang.String sessionId, java.lang.Long entityTypeId, java.lang.Long entityId, java.lang.Long methodId, java.lang.String methodValue) throws AxisFault
sessionId
- The Session ID string returned by the Login operation.entityTypeId
- The ID of the entity type you are working with. You can find the IDs in the Innotas app on Admin/Web Services API.entityId
- The unique ID of the instance of the entity type to update. You can find this ID on the Info page of the
entity (Resource Info, Project Info, and so on), or you can run a report.methodId
- The ID of the attribute (field) to update. You can find field/method IDs in the Innnotas app
on Admin/Web Services API. Click on the Fields link for the appropriate entity and look at
the Update tab for the list of fields and their IDs.methodValue
- The value to set the field/method to.AxisFault
- thrown if the session is invalid or if an Entity Type is not supported or a system error occured.updateEntity (update a specific entity)
public java.lang.Boolean deleteEntity(java.lang.String sessionId, java.lang.Long entityTypeId, java.lang.Long entityId) throws AxisFault
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:deleteEntity>
<ser:sessionId>f6675d30-9c55-4b62-9438-d8fa5afaf80b</ser:sessionId>
<ser:entityTypeId>5</ser:entityTypeId>
<ser:entityId>1163210614</ser:entityId>
</ser:deleteEntity>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.entityTypeId
- The ID of the entity type you are working with. You can find the IDs in the Innotas app on Admin/Web Services API.entityId
- Unique ID of the entity being deleted.AxisFault
- An exception occurs if the session is invalid or if an Entity cannot be found
or a system error occured.public java.lang.Boolean deleteEntities(java.lang.String sessionId, java.lang.Long entityTypeId, java.lang.Long[] entityIds) throws AxisFault
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:deleteEntities>
<ser:sessionId>f6675d30-9c55-4b62-9438-d8fa5afaf80b</ser:sessionId>
<ser:entityTypeId>5</ser:entityTypeId>
<!--one or more repetitions:-->
<ser:entityIds>1163210614</ser:entityIds>
<ser:entityIds>813103075</ser:entityIds>
</ser:deleteEntities>
</soapenv:Body>
</soapenv:Envelope>
Response:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:deleteEntitiesResponse xmlns:ns="http://services">
<ns:return>true</ns:return>
</ns:deleteEntitiesResponse>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- Session ID string returned by the Login operation.entityTypeId
- The ID of the entity type you are working with. You can find the IDs in the Innotas app on Admin/Web Services API.entityIds
- Array of unique IDs of the entities to delete.AxisFault
- is thrown when the session is invalid, if an entity cannot be found/deleted,
or when a system error occured.public EntityObj selectEntity(java.lang.String sessionId, java.lang.Long entityTypeId, java.lang.Long entityId, java.lang.Long[] fieldsRequest) throws AxisFault
sessionId
- The Session ID string returned by the Login operation.entityTypeId
- The ID of the entity type you are working with.
See the Admin>Web Services API page in the application for the list of
supported Entity Types and their corresponding IDs.entityId
- The unique ID of the instance of the entity from which to return fields. You can find this
ID on the Info page of the entity (Resource Info, Project Info, and so on), or you can run a report.fieldsRequest
- Array of specific attributes/fields to return, or all if nullAxisFault
- thrown when the session is invalid or if an Entity cannot be found
or a system error occured.public EntityObj[] getEntitiesByFilter(java.lang.String sessionId, java.lang.Long entityTypeId, java.lang.String filter, java.lang.Long[] fieldsRequest) throws AxisFault
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:getEntitiesByFilter>
<ser:sessionId>be9d3093-f6c0-4014-9f23-c6511afcd1fb</ser:sessionId>
<ser:entityTypeId>4</ser:entityTypeId>
<ser:filter>Maintenance Project Open to All</ser:filter>
<ser:fieldsRequest>436</ser:fieldsRequest> <--! return project title-->
</ser:getEntitiesByFilter>
</soapenv:Body>
</soapenv:Envelope>
Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:getEntitiesByFilterResponse xmlns:ns="http://services" xmlns:ax21="http://objects.services/xsd">
<ns:return xsi:type="ax21:EntityObj" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:entityId>73418480</ax21:entityId>
<ax21:entityTypeId>4</ax21:entityTypeId>
<ax21:methodValues xsi:type="ax21:ValuePair">
<ax21:elementValue>A Test</ax21:elementValue>
<ax21:id>436</ax21:id>
</ax21:methodValues>
</ns:return>
</ns:getEntitiesByFilterResponse>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- the The Session ID string returned by the Login operation.entityTypeId
- The ID of the entity type you are working with. See the Admin>Web Services
API page in the application for the list of supported Entity Types and their corresponding IDs.filter
- Innotas filter ID or filter name. You can find filter names in the Innotas app
on Admin>Setup>Filters. You can get the filter ID by editing the filter and getting it from the URL.fieldsRequest
- Array of attributes/fields to return. If null, all fields are returned.AxisFault
- when the session is invalid, if an Entity cannot be found, or if a system error occured.public EntityHistoryObj[] getEntitiesByFilterUpdateHistory(java.lang.String sessionId, java.lang.Long entityTypeId, java.lang.String filter, java.lang.String updatedFrom, java.lang.String updatedTo, java.lang.Long[] fieldsRequest) throws AxisFault
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:getEntitiesByFilterUpdateHistory>
<ser:sessionId>2c5f344f-3a8e-4e6b-9050-1176a039745f</ser:sessionId>
<ser:entityTypeId>4</ser:entityTypeId>
<ser:filter>1415821965938</ser:filter>
<ser:updatedFrom>2017-07-16T19:20+01:00</ser:updatedFrom>
<ser:updatedTo>2017-07-25T01:46:00Z</ser:updatedTo>
<ser:fieldsRequest>436</ser:fieldsRequest>
<ser:fieldsRequest>411</ser:fieldsRequest>
<ser:fieldsRequest>100466</ser:fieldsRequest>
<ser:fieldsRequest>428</ser:fieldsRequest>
</ser:getEntitiesByFilterUpdateHistory>
</soapenv:Body>
</soapenv:Envelope>
Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:getEntitiesByFilterUpdateHistoryResponse xmlns:ns="http://services" xmlns:ax21="http://objects.services/xsd">
<ns:return xsi:type="ax21:EntityHistoryFields" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:dateModified xsi:nil="true"/>
<ax21:entityId>858150442</ax21:entityId>
<ax21:entityTypeId>4</ax21:entityTypeId>
<ax21:methodValues xsi:type="ax21:ValuePair">
<ax21:elementValue>Support: Business Applications</ax21:elementValue>
<ax21:id>436</ax21:id>
</ax21:methodValues>
<ax21:methodValues xsi:type="ax21:ValuePair">
<ax21:elementValue>Support/Maintenance</ax21:elementValue>
<ax21:id>411</ax21:id>
</ax21:methodValues>
<ax21:methodValues xsi:type="ax21:ValuePair">
<ax21:elementValue>01/01/2014</ax21:elementValue>
<ax21:id>100466</ax21:id>
</ax21:methodValues>
<ax21:methodValues xsi:type="ax21:ValuePair">
<ax21:elementValue>01/02/2014</ax21:elementValue>
<ax21:id>428</ax21:id>
</ax21:methodValues>
<ax21:modifiedBy>0</ax21:modifiedBy>
</ns:return>
</ns:getEntitiesByFilterUpdateHistoryResponse>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.entityTypeId
- The ID of the entity type you are working with. See the Admin>Web Services
API page in the application for the list of supported Entity Types and their corresponding IDs.filter
- Innotas filter ID or filter name.updatedFrom
- String representation of the start date of a period in the form YYYY-MM-DDThh:mmTZD (eg 2017-07-16T19:20+01:00)updatedTo
- String representation of the end date of a period in the form YYYY-MM-DDThh:mmTZD (eg 2017-07-16T19:20+01:00)fieldsRequest
- Array of attributes/fields to return. If null, all fields are returned.AxisFault
- when the session is invalid, if an Entity cannot be found, or if a system error occured.public EntityObj[] findEntity(java.lang.String sessionId, java.lang.Long entityTypeId, ValuePair[] searchValuePairs, java.lang.Long[] fieldsRequest) throws AxisFault
Example
The example below searches for projects (entity 4) whose status (411) is Open, and returns the title of any project that meets that criteria.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services" xmlns:xsd="http://objects.services/xsd">
<soapenv:Header/>
<soapenv:Body>
<ser:findEntity>
<ser:sessionId>91253ba1-ee1e-4fbd-8eb6-26ecddb3cb44</ser:sessionId>
<ser:entityTypeId>4</ser:entityTypeId>
<ser:searchValuePairs>
<xsd:elementValue>Open</xsd:elementValue>
<xsd:id>411</xsd:id>
</ser:searchValuePairs>
<ser:fieldsRequest>436</ser:fieldsRequest>
</ser:findEntity>
</soapenv:Body>
</soapenv:Envelope>
Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:findEntityResponse xmlns:ns="http://services" xmlns:ax21="http://objects.services/xsd">
<ns:return xsi:type="ax21:EntityObj" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:entityId>8387598</ax21:entityId>
<ax21:entityTypeId>4</ax21:entityTypeId>
<ax21:methodValues xsi:type="ax21:ValuePair">
<ax21:elementValue>Project 001</ax21:elementValue>
<ax21:id>436</ax21:id>
</ax21:methodValues>
</ns:return>
<ns:return xsi:type="ax21:EntityObj" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:entityId>8387608</ax21:entityId>
<ax21:entityTypeId>4</ax21:entityTypeId>
<ax21:methodValues xsi:type="ax21:ValuePair">
<ax21:elementValue>Project 002</ax21:elementValue>
<ax21:id>436</ax21:id>
</ax21:methodValues>
</ns:return>
<ns:return xsi:type="ax21:EntityObj" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:entityId>8387613</ax21:entityId>
<ax21:entityTypeId>4</ax21:entityTypeId>
<ax21:methodValues xsi:type="ax21:ValuePair">
<ax21:elementValue>Project 004</ax21:elementValue>
<ax21:id>436</ax21:id>
</ax21:methodValues>
</ns:return>
</ns:findEntityResponse>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.entityTypeId
- The ID of the entity type you are working with. See the Admin>Web Services
API page in the application for the list of supported Entity Types and their corresponding IDs.searchValuePairs
- Search criteria in the form of method-value pairs. These
values are used to determine if the entity already exists. You must supply at least one value pair.
Note: searchValuePairs are currently not supported for UDFs defined on the request entity (96).fieldsRequest
- Array of attributes/fields to return. If null, returns all fields.AxisFault
- when the session is invalid, if an entity cannot be found, or if a system error occured.public EntityHistoryObj[] findEntityUpdateHistory(java.lang.String sessionId, java.lang.Long entityTypeId, java.lang.String updatedFrom, java.lang.String updatedTo, ValuePair[] searchValuePairs, java.lang.Long[] fieldsRequest) throws AxisFault
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:findEntityUpdateHistory>
<ser:sessionId>2c5f344f-3a8e-4e6b-9050-1176a039745f</ser:sessionId>
<ser:entityTypeId>4</ser:entityTypeId>
<ser:filter>1415821965938</ser:filter>
<ser:updatedFrom>2017-07-16T19:20+01:00</ser:updatedFrom>
<ser:updatedTo>2017-07-25T01:46:00Z</ser:updatedTo>
<ser:fieldsRequest>436</ser:fieldsRequest>
<ser:fieldsRequest>411</ser:fieldsRequest>
<ser:fieldsRequest>100466</ser:fieldsRequest>
<ser:fieldsRequest>428</ser:fieldsRequest>
</ser:findEntityUpdateHistory>
</soapenv:Body>
</soapenv:Envelope>
Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:findEntityUpdateHistoryResponse xmlns:ns="http://services" xmlns:ax21="http://objects.services/xsd">
<ns:return xsi:type="ax21:EntityHistoryFields" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:dateModified xsi:nil="true"/>
<ax21:entityId>863235065</ax21:entityId>
<ax21:entityTypeId>4</ax21:entityTypeId>
<ax21:methodValues xsi:type="ax21:ValuePair">
<ax21:elementValue>PMO</ax21:elementValue>
<ax21:id>15797646</ax21:id>
</ax21:methodValues>
<ax21:methodValues xsi:type="ax21:ValuePair">
<ax21:elementValue>Tablet Deployment</ax21:elementValue>
<ax21:id>436</ax21:id>
</ax21:methodValues>
<ax21:modifiedBy>0</ax21:modifiedBy>
</ns:return>
</ns:findEntityUpdateHistoryResponse>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.entityTypeId
- The ID of the entity type you are working with. See the Admin>Web ServicesupdatedFrom
- String representation of the start date of a period in the form YYYY-MM-DDThh:mmTZD (eg 2017-07-16T19:20+01:00)updatedTo
- String representation of the end date of a period in the form YYYY-MM-DDThh:mmTZD (eg 2017-07-16T19:20+01:00)searchValuePairs
- Search criteria in the form of method-value pairs. These values are used to determine if the entity already exists.fieldsRequest
- Array of specific attributes/fields to return, or all if nullAxisFault
public TTAssociate[] getUpdateHistoryForBasicAssociations(java.lang.String sessionId, java.lang.Long sourceEntityTypeId, java.lang.Long targetEntityTypeId, java.lang.String updatedFrom, java.lang.String updatedTo, java.lang.Boolean showRepeatingPerDay) throws AxisFault
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:getUpdateHistoryForBasicAssociations>
<ser:sessionId>31c7ee92-c163-41d3-a6a5-b9e58b1c747b</ser:sessionId>
<ser:sourceEntityTypeId>6</ser:sourceEntityTypeId>
<ser:targetEntityTypeId>6</ser:targetEntityTypeId>
<ser:updatedFrom>2017-09-10T07:50:00</ser:updatedFrom>
<ser:updatedTo>2017-11-22T07:50:00</ser:updatedTo>
<ser:showRepeatingPerDay>false</ser:showRepeatingPerDay>
</ser:getUpdateHistoryForBasicAssociations>
</soapenv:Body>
</soapenv:Envelope>
Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:getUpdateHistoryForBasicAssociationsResponse xmlns:ns="http://services" xmlns:ax21="http://objects.services/xsd">
<ns:return xsi:type="ax21:TTAssociate" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:associateId>1638656686</ax21:associateId>
<ax21:createDate>2017-11-21 17:09:01.0</ax21:createDate>
<ax21:createdBy>8826911</ax21:createdBy>
<ax21:currentEntry>0</ax21:currentEntry>
<ax21:dateModified>2017-11-21 17:09:28.0</ax21:dateModified>
<ax21:modifiedBy>8826911</ax21:modifiedBy>
<ax21:sourceEntityId>1638656522</ax21:sourceEntityId>
<ax21:sourceEntityTypeId>6</ax21:sourceEntityTypeId>
<ax21:targetEntityId>863251807</ax21:targetEntityId>
<ax21:targetEntityTypeId>6</ax21:targetEntityTypeId>
</ns:return>
<ns:return xsi:type="ax21:TTAssociate" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:associateId>1638656687</ax21:associateId>
<ax21:createDate>2017-11-21 17:09:01.0</ax21:createDate>
<ax21:createdBy>8826911</ax21:createdBy>
<ax21:currentEntry>0</ax21:currentEntry>
<ax21:dateModified>2017-11-21 17:09:28.0</ax21:dateModified>
<ax21:modifiedBy>8826911</ax21:modifiedBy>
<ax21:sourceEntityId>863251807</ax21:sourceEntityId>
<ax21:sourceEntityTypeId>6</ax21:sourceEntityTypeId>
<ax21:targetEntityId>1638656522</ax21:targetEntityId>
<ax21:targetEntityTypeId>6</ax21:targetEntityTypeId>
</ns:return>
</ns:getUpdateHistoryForBasicAssociationsResponse>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.sourceEntityTypeId
- The ID of the source entity type you are working with. See the Admin>Web ServicestargetEntityTypeId
- The ID of the target entity type you are working with. See the Admin>Web ServicesupdatedFrom
- String representation of the start date of a period in the form YYYY-MM-DDThh:mmTZD (eg 2017-07-16T19:20+01:00)updatedTo
- String representation of the end date of a period in the form YYYY-MM-DDThh:mmTZD (eg 2017-07-16T19:20+01:00)showRepeatingPerDay
- Set to TRUE to view the date-time of each update per day. FALSE will display the last update in the day,
if there are multiple updates in one day.AxisFault
public TTAssociate[] selectBasicAssociations(java.lang.String sessionId, java.lang.Long sourceEntityTypeId, java.lang.Long sourceEntityId, java.lang.Long targetEntityTypeId, java.lang.Long targetEntityId) throws AxisFault
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:selectBasicAssociations>
<ser:sessionId>31c7ee92-c163-41d3-a6a5-b9e58b1c747b</ser:sessionId>
<ser:sourceEntityTypeId>6</ser:sourceEntityTypeId>
<ser:sourceEntityId>6</ser:sourceEntityTypeId>
<ser:targetEntityTypeId>6</ser:targetEntityTypeId>
<ser:targetEntityId>6</ser:targetEntityTypeId>
</ser:selectBasicAssociations>
</soapenv:Body>
</soapenv:Envelope>
Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:selectBasicAssociationsResponse xmlns:ns="http://services" xmlns:ax21="http://objects.services/xsd">
<ns:return xsi:type="ax21:TTAssociate" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:associateId>1638656686</ax21:associateId>
<ax21:createDate>2017-11-21 17:09:01.0</ax21:createDate>
<ax21:createdBy>8826911</ax21:createdBy>
<ax21:currentEntry>0</ax21:currentEntry>
<ax21:dateModified>2017-11-21 17:09:28.0</ax21:dateModified>
<ax21:modifiedBy>8826911</ax21:modifiedBy>
<ax21:sourceEntityId>1638656522</ax21:sourceEntityId>
<ax21:sourceEntityTypeId>6</ax21:sourceEntityTypeId>
<ax21:targetEntityId>863251807</ax21:targetEntityId>
<ax21:targetEntityTypeId>6</ax21:targetEntityTypeId>
</ns:return>
</ns:selectBasicAssociationsResponse>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.sourceEntityTypeId
- The ID of the source entity type you are working with. See the Admin>Web ServicessourceEntityId
- The ID of the source entity type you are working with. See the Admin>Web ServicestargetEntityTypeId
- The ID of the target entity type you are working with. See the Admin>Web ServicestargetEntityId
- The ID of the target entity type you are working with. See the Admin>Web ServicesAxisFault
public TTAssociate[] getBasicAssociations(java.lang.String sessionId, java.lang.Long sourceEntityTypeId, java.lang.Long sourceEntityId, java.lang.Long targetEntityTypeId) throws AxisFault
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:getBasicAssociations>
<ser:sessionId>31c7ee92-c163-41d3-a6a5-b9e58b1c747b</ser:sessionId>
<ser:sourceEntityTypeId>5</ser:sourceEntityTypeId>
<ser:sourceEntityId>1638656517</ser:sourceEntityTypeId>
<ser:targetEntityTypeId>6</ser:targetEntityTypeId>
</ser:getBasicAssociations>
</soapenv:Body>
</soapenv:Envelope>
Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:getBasicAssociationsResponse xmlns:ns="http://services" xmlns:ax21="http://objects.services/xsd">
<ns:return xsi:type="ax21:TTAssociate" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:associateId>1638656686</ax21:associateId>
<ax21:createDate>2017-11-21 17:09:01.0</ax21:createDate>
<ax21:createdBy>8826911</ax21:createdBy>
<ax21:currentEntry>0</ax21:currentEntry>
<ax21:dateModified>2017-11-21 17:09:28.0</ax21:dateModified>
<ax21:modifiedBy>8826911</ax21:modifiedBy>
<ax21:sourceEntityId>1638656517</ax21:sourceEntityId>
<ax21:sourceEntityTypeId>5</ax21:sourceEntityTypeId>
<ax21:targetEntityId>1638656522</ax21:targetEntityId>
<ax21:targetEntityTypeId>6</ax21:targetEntityTypeId>
</ns:return>
<ns:return xsi:type="ax21:TTAssociate" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:associateId>1638656686</ax21:associateId>
<ax21:createDate>2017-11-21 17:09:01.0</ax21:createDate>
<ax21:createdBy>8826911</ax21:createdBy>
<ax21:currentEntry>0</ax21:currentEntry>
<ax21:dateModified>2017-11-21 17:09:28.0</ax21:dateModified>
<ax21:modifiedBy>8826911</ax21:modifiedBy>
<ax21:sourceEntityId>1638656517</ax21:sourceEntityId>
<ax21:sourceEntityTypeId>5</ax21:sourceEntityTypeId>
<ax21:targetEntityId>866071915</ax21:targetEntityId>
<ax21:targetEntityTypeId>6</ax21:targetEntityTypeId>
</ns:return>
</ns:getBasicAssociations>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.sourceEntityTypeId
- The ID of the source entity type you are working with. See the Admin>Web ServicessourceEntityId
- The ID of the source entity type you are working with. See the Admin>Web ServicestargetEntityTypeId
- The ID of the target entity type you are working with. See the Admin>Web ServicesAxisFault
public TTAssociate[] addBasicAssociation(java.lang.String sessionId, java.lang.Long sourceEntityTypeId, java.lang.Long sourceEntityId, java.lang.Long targetEntityTypeId, java.lang.Long targetEntityId) throws AxisFault
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:addBasicAssociation>
<ser:sessionId>31c7ee92-c163-41d3-a6a5-b9e58b1c747b</ser:sessionId>
<ser:sourceEntityTypeId>5</ser:sourceEntityTypeId>
<ser:sourceEntityId>1638656517</ser:sourceEntityTypeId>
<ser:targetEntityTypeId>6</ser:targetEntityTypeId>
<ser:targetEntityId>1638656522</ser:targetEntityTypeId>
</ser:addBasicAssociation>
</soapenv:Body>
</soapenv:Envelope>
Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:addBasicAssociationResponse xmlns:ns="http://services" xmlns:ax21="http://objects.services/xsd">
<ns:return xsi:type="ax21:TTAssociate" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:associateId>1638656686</ax21:associateId>
<ax21:createDate>2017-11-21 17:09:01.0</ax21:createDate>
<ax21:createdBy>8826911</ax21:createdBy>
<ax21:currentEntry>0</ax21:currentEntry>
<ax21:dateModified>2017-11-21 17:09:28.0</ax21:dateModified>
<ax21:modifiedBy>8826911</ax21:modifiedBy>
<ax21:sourceEntityId>1638656517</ax21:sourceEntityId>
<ax21:sourceEntityTypeId>5</ax21:sourceEntityTypeId>
<ax21:targetEntityId>1638656522</ax21:targetEntityId>
<ax21:targetEntityTypeId>6</ax21:targetEntityTypeId>
</ns:return>
</ns:addBasicAssociation>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.sourceEntityTypeId
- The ID of the source entity type you are working with. See the Admin>Web ServicessourceEntityId
- The ID of the source entity type you are working with. See the Admin>Web ServicestargetEntityTypeId
- The ID of the target entity type you are working with. See the Admin>Web ServicestargetEntityId
- The ID of the target entity type you are working with. See the Admin>Web ServicesAxisFault
public java.lang.Boolean removeBasicAssociation(java.lang.String sessionId, java.lang.Long sourceEntityTypeId, java.lang.Long sourceEntityId, java.lang.Long targetEntityTypeId, java.lang.Long targetEntityId) throws AxisFault
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:removeBasicAssociation>
<ser:sessionId>31c7ee92-c163-41d3-a6a5-b9e58b1c747b</ser:sessionId>
<ser:sourceEntityTypeId>5</ser:sourceEntityTypeId>
<ser:sourceEntityId>1638656517</ser:sourceEntityTypeId>
<ser:targetEntityTypeId>6</ser:targetEntityTypeId>
<ser:targetEntityId>1638656522</ser:targetEntityTypeId>
</ser:removeBasicAssociation>
</soapenv:Body>
</soapenv:Envelope>
Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:removeBasicAssociationResponse xmlns:ns="http://services" xmlns:ax21="http://objects.services/xsd">
<ns:return xsi:type="ax21:TTAssociate" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:associateId>1638656686</ax21:associateId>
<ax21:createDate>2017-11-21 17:09:01.0</ax21:createDate>
<ax21:createdBy>8826911</ax21:createdBy>
<ax21:currentEntry>0</ax21:currentEntry>
<ax21:dateModified>2017-11-21 17:09:28.0</ax21:dateModified>
<ax21:modifiedBy>8826911</ax21:modifiedBy>
<ax21:sourceEntityId>1638656517</ax21:sourceEntityId>
<ax21:sourceEntityTypeId>5</ax21:sourceEntityTypeId>
<ax21:targetEntityId>1638656522</ax21:targetEntityId>
<ax21:targetEntityTypeId>6</ax21:targetEntityTypeId>
</ns:return>
</ns:removeBasicAssociation>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.sourceEntityTypeId
- The ID of the source entity type you are working with. See the Admin>Web ServicessourceEntityId
- The ID of the source entity type you are working with. See the Admin>Web ServicestargetEntityTypeId
- The ID of the target entity type you are working with. See the Admin>Web ServicestargetEntityId
- The ID of the target entity type you are working with. See the Admin>Web ServicesAxisFault
public java.lang.String createOrReplace(java.lang.String sessionId, EntityObj newObj, ValuePair[] searchValuePairs) throws AxisFault
insertEntity
instead.
For any given entity
there are a set of fields that are required when creating/updating the entity. These field values must be passed
in as methodValue pairs in the EntityObj
. To determine required fields for any entity,
go to Admin>Web Services API in the Innotas application. Click the Fields link for an entity and locate
the required fields for insert/update.
Example
The example below shows a createOrReplace for a project. It includes a searchValuePairs element that checks to see that a project with the same title exists (Title field ID=436). Not all of the required fields are included in this example:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services" xmlns:xsd="http://objects.services/xsd">
<soapenv:Header/>
<soapenv:Body>
<ser:createOrReplace>
<ser:sessionId>45360a69-9062-448c-9c88-17b400d75c7c</ser:sessionId>
<ser:newObj>
<xsd:entityId>aa166145-3069-4cbb-ae5f-4acba52a9aab</xsd:entityId>
<xsd:entityTypeId>4</xsd:entityTypeId>
<xsd:methodValues>
<xsd:elementValue>MyNewProjectTitle</xsd:elementValue> <--!Project Title>
<xsd:id>436</xsd:id>
</xsd:methodValues>
<xsd:methodValues>
<xsd:elementValue>8826911</xsd:elementValue> <--!Project Owner, Resource ID-->
<xsd:id>414</xsd:id>
</xsd:methodValues>
<xsd:methodValues>
<xsd:elementValue>Rose, Jennifer</xsd:elementValue> <--!Project Owner, Last Name, First Name-->
<xsd:id>416</xsd:id>
</xsd:methodValues>
<xsd:methodValues>
<xsd:elementValue>Program ID</xsd:elementValue>
<xsd:id>423</xsd:id>
</xsd:methodValues>
<xsd:methodValues>
<xsd:elementValue>ProgramName</xsd:elementValue>
<xsd:id>425</xsd:id>
</xsd:methodValues>
</ser:newObj>
<ser:searchValuePairs>
<xsd:elementValue>MyNewProjectTitle</xsd:elementValue> <!--checking to see if project with this title already exists-->
<xsd:id>436</xsd:id>
</ser:searchValuePairs>
</ser:createOrReplace>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.newObj
- An EntityObj
containing the entity ID, entityTypeId, and set of methodValue pairs
describing the new object to be created.searchValuePairs
- Search criteria in the form of method-value pairs. These values are used to determine
if the entity already exists.AxisFault
- thrown if the session ID is invalid or if more than one
matching Entity was found based on the searchValuePairs.updateEntity (update a specific Object)
,
insertEntity (create an Object)
public java.lang.String allocateResourceTime(java.lang.String sessionId, java.lang.Long[] taskIds, java.lang.Long[] resourceIds, java.lang.Long[] orgRoleIds, java.lang.Float estimateHours, java.lang.Float scheduleHours, java.lang.Float percentOfTime, java.lang.Float hoursToComplete) throws AxisFault
Note that if you are scheduling multiple resources, each resource will be assigned to each task under each role. For example, if you specify 3 resources, 3 org roles, and 3 tasks, then 27 allocations will be made (3 resources times 3 roles for each of 3 tasks). If you specify 3 resources, 3 tasks, and one org role, then each resource will be scheduled to each task under the same org role (9 total allocations).
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:allocateResourceTime>
<ser:sessionId>b1c523e0-2194-427b-9eac-6ef906568021</ser:sessionId>
<ser:taskIds>73456709</ser:taskIds>
<ser:taskIds>73456709</ser:taskIds>
<ser:resourceIds>8826911</ser:resourceIds>
<ser:orgRoleIds>8350021</ser:orgRoleIds>
<ser:estimateHours>10</ser:estimateHours>
<ser:scheduleHours>5</ser:scheduleHours>
<ser:percentOfTime></ser:percentOfTime> <!--Do not use-->
<ser:hoursToComplete>5</ser:hoursToComplete>
</ser:allocateResourceTime>
</soapenv:Body>
</soapenv:Envelope>
Response:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:allocateResourceTimeResponse xmlns:ns="http://services">
<ns:return>Task Schedule 1163365729 processed.
Task Schedule 1163366015 processed.</ns:return>
</ns:allocateResourceTimeResponse>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.taskIds
- Array of Task IDs.resourceIds
- Array of Human Resource or User IDs..orgRoleIds
- (Optional) Array of Org Role IDs. If null, Resources will be assigned a default
'no role' role.estimateHours
- Value for estimated hours (if Task Type permits user-setting). Default is 0.scheduleHours
- Value for scheduled hours (if Task Type permits user-setting). Default is 0.percentOfTime
- (this is now obsolete - do not use)hoursToComplete
- Value for hours to complete (HTC). Default is 0.AxisFault
- thrown if the session is invalid or if a system error occured, or
if the system encounters one or more invalid Task ID or Human Resource ID.public ValuePair[] getRequestTypes(java.lang.String sessionId, java.lang.String idOrTitle) throws AxisFault
Example
The following example sends a request for all request type IDs. The response returns ValuePair objects containing the ID and the name.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:getRequestTypes>
<ser:sessionId>45360a69-9062-448c-9c88-17b400d75c7c</ser:sessionId>
<!--Optional:-->
<ser:idOrTitle></ser:idOrTitle> <--! no value means return all request type IDs-->
</ser:getRequestTypes>
</soapenv:Body>
</soapenv:Envelope>
Response:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:getRequestTypesResponse xmlns:ns="http://services" xmlns:ax21="http://objects.services/xsd">
<ns:return xsi:type="ax21:ValuePair" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:elementValue>Project Initiation Request</ax21:elementValue>
<ax21:id>1143566659928</ax21:id>
</ns:return>
<ns:return xsi:type="ax21:ValuePair" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:elementValue>Project Change Request</ax21:elementValue>
<ax21:id>1143566729582</ax21:id>
</ns:return>
<ns:return xsi:type="ax21:ValuePair" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:elementValue>Application Enhancement Request</ax21:elementValue>
<ax21:id>1175185437184</ax21:id>
</ns:return>
<ns:return xsi:type="ax21:ValuePair" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:elementValue>Break-Fix Request</ax21:elementValue>
<ax21:id>1175185558261</ax21:id>
</ns:return>
...
</ns:getRequestTypesResponse>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.idOrTitle
- (Optional) The ID or Title of the request whose type will be returned.
If null, returns all request types. Note that request Titles
are not unique in the system.AxisFault
- thrown if the session ID is invalid, if a Request Id or Title is not valid, or if a system error occured.public ObjectMethod[] getRequestFields(java.lang.String sessionId, java.lang.Long requestTypeId) throws AxisFault
Example
The example below shows a request for fields for a Project Initiation Request (1143566659928) type. Issue
getRequestTypes
for a list of all request types. The response
shows an example of a few of the fields on that request type.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:getRequestFields>
<ser:sessionId>45360a69-9062-448c-9c88-17b400d75c7c</ser:sessionId>
<ser:requestTypeId>1143566659928</ser:requestTypeId> <--! Project Initiation Request-->
</ser:getRequestFields>
</soapenv:Body>
</soapenv:Envelope>
Response:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:getRequestFieldsResponse xmlns:ns="http://services" xmlns:ax21="http://objects.services/xsd">
<ns:return xsi:type="ax21:ObjectMethod" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:defaultValue xsi:nil="true"/>
<ax21:fieldLength>0</ax21:fieldLength>
<ax21:fieldSubTypeId>0</ax21:fieldSubTypeId>
<ax21:fieldTypeId>13</ax21:fieldTypeId>
<ax21:isRequired>false</ax21:isRequired>
<ax21:label>Request: Can I Score</ax21:label>
<ax21:method>canIScore</ax21:method>
<ax21:methodId>9677</ax21:methodId>
<ax21:onInsert>false</ax21:onInsert>
<ax21:onSelect>true</ax21:onSelect>
<ax21:onUpdate>false</ax21:onUpdate>
<ax21:sequence>0</ax21:sequence>
</ns:return>
<ns:return xsi:type="ax21:ObjectMethod" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:defaultValue xsi:nil="true"/>
<ax21:fieldLength>80</ax21:fieldLength>
<ax21:fieldSubTypeId>7</ax21:fieldSubTypeId>
<ax21:fieldTypeId>44</ax21:fieldTypeId>
<ax21:isRequired>false</ax21:isRequired>
<ax21:label>Request: Gate</ax21:label>
<ax21:method>gateId</ax21:method>
<ax21:methodId>9621</ax21:methodId>
<ax21:onInsert>true</ax21:onInsert>
<ax21:onSelect>true</ax21:onSelect>
<ax21:onUpdate>true</ax21:onUpdate>
<ax21:sequence>10</ax21:sequence>
</ns:return>
...
</ns:getRequestFieldsResponse>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.requestTypeId
- The ID of the request type whose fields to return. Use getRequestTypes to find the ID.AxisFault
- thrown if the session ID is invalid, if a request type ID is not supported, or a system error occured.public java.lang.Long createOrReplaceRequest(java.lang.String sessionId, java.lang.Long requestTypeId, ValuePair[] valuePairs) throws AxisFault
getRequestFields
.
If you wish to update a request, ensure that the first value pair passed in is the Request ID (9601 is the Request ID field ID).
If you are creating a new request, the response will be the ID of the request that was just created.
Example
There are three required fields to create a new request in the system.
After the request is created, you can call submitRequest
,
which will put the request at the first gate in the process.
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<createOrReplaceRequest xmlns="http://services">
<sessionId>BDB3FCC8E8BC825757228ACCDB85D64C</sessionId>
<requestTypeId>1143566659928</requestTypeId>
<valuePairs>
<elementValue xmlns="http://objects.services/xsd">New Request Title</elementValue>
<id xmlns="http://objects.services/xsd">9602</id>
</valuePairs>
<valuePairs>
<elementValue xmlns="http://objects.services/xsd">0</elementValue>
<id xmlns="http://objects.services/xsd">9617</id>
</valuePairs>
<valuePairs>
<elementValue xmlns="http://objects.services/xsd">8826911</elementValue>
<id xmlns="http://objects.services/xsd">9613</id>
</valuePairs>
<valuePairs>
<elementValue xmlns="http://objects.services/xsd">test</elementValue>
<id xmlns="http://objects.services/xsd">153337327</id>
</valuePairs>
<valuePairs>
<elementValue xmlns="http://objects.services/xsd">Information Technology</elementValue>
<id xmlns="http://objects.services/xsd">9627144</id>
</valuePairs>
<valuePairs>
<elementValue xmlns="http://objects.services/xsd">Description of Need</elementValue>
<id xmlns="http://objects.services/xsd">9627012</id>
</valuePairs>
<valuePairs>
<elementValue xmlns="http://objects.services/xsd">Solution Requested</elementValue>
<id xmlns="http://objects.services/xsd">9627028</id>
</valuePairs>
<valuePairs>
<elementValue xmlns="http://objects.services/xsd">Impacts to Existing processes</elementValue>
<id xmlns="http://objects.services/xsd">9627227</id>
</valuePairs>
<valuePairs>
<elementValue xmlns="http://objects.services/xsd">This project is needed ASAP!</elementValue>
<id xmlns="http://objects.services/xsd">10052232</id>
</valuePairs>
</createOrReplaceRequest>
</s:Body>
</s:Envelope>
Response:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:createOrReplaceRequestResponse xmlns:ns="http://services">
<ns:return>625476129</ns:return>
</ns:createOrReplaceRequestResponse>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.requestTypeId
- The ID corresponding to the request type. The ID can be found by using
getRequestTypes
.valuePairs
- Array of methodId-value pairs representing the field IDs/values for the request.
Use getRequestFields
to discover the fields for a particular request.AxisFault
- thrown the session is invalid or if an Request Type is not supported or a system error occured.public java.lang.Boolean submitRequest(java.lang.String sessionId, java.lang.Long requestId) throws AxisFault
Example
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:submitRequest>
<ser:sessionId>749F5848D97F21A08E2FFB412FA438B4</ser:sessionId>
<ser:requestId>625476129</ser:requestId>
</ser:submitRequest>
</soapenv:Body>
</soapenv:Envelope>
Response:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:submitRequestResponse xmlns:ns="http://services">
<ns:return>true</ns:return>
</ns:submitRequestResponse>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.requestId
- The ID of the request you want to submit.AxisFault
- thrown when the session ID is invalid or if request cannot be submitted.public java.lang.Boolean submitRequests(java.lang.String sessionId, java.lang.Long[] requestIds) throws AxisFault
createOrReplaceRequest
.sessionId
- The Session ID string returned by the Login operation.requestIds
- Array of Innotas Request IDs to submitAxisFault
- thrown when the session ID is invalid or if request cannot be submitted.public ValuePair[] getPortfolioTypes(java.lang.String sessionId, java.lang.String idOrTitle) throws AxisFault
Example
The following example sends a request for all portfolio type IDs. The response returns ValuePair objects containing the ID and the name.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:getPortfolioTypes>
<!--Optional:-->
<ser:sessionId>dd0a31c7-1516-43b4-aab2-aef350104fba</ser:sessionId>
<!--Optional:-->
<ser:idOrTitle></ser:idOrTitle> <!--Returns all IDs if left blank, or returns ID for specified portfolio-->
</ser:getPortfolioTypes>
</soapenv:Body>
</soapenv:Envelope>
Response:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:getPortfolioTypesResponse xmlns:ns="http://services" xmlns:ax21="http://objects.services/xsd">
<ns:return xsi:type="ax21:ValuePair" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:elementValue>Portfolio Type I</ax21:elementValue>
<ax21:id>8408709</ax21:id>
</ns:return>
<ns:return xsi:type="ax21:ValuePair" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:elementValue>Portfolio Type II</ax21:elementValue>
<ax21:id>8408893</ax21:id>
</ns:return>
<ns:return xsi:type="ax21:ValuePair" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:elementValue>Portfolio Type III</ax21:elementValue>
<ax21:id>8409588</ax21:id>
</ns:return>
...
</ns:getPortfolioTypesResponse>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.idOrTitle
- (Optional) ID or Title of the Portfolio.
If null, returns all Portfolio Types.AxisFault
- thrown if the session is invalid, if a Portfolio Id or Title is not valid, or a system error occured.public ObjectMethod[] getPortfolioFields(java.lang.String sessionId, java.lang.Long portfolioTypeId) throws AxisFault
Example
The example below shows a request and then a partial response, showing only 2 required fields (there are about 12 more).
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:getPortfolioFields>
<ser:sessionId>d8d23969-3e90-4132-a684-dd418e441704</ser:sessionId>
<ser:portfolioTypeId>8408893</ser:portfolioTypeId>
</ser:getPortfolioFields>
</soapenv:Body>
</soapenv:Envelope>
Response:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:getPortfolioFieldsResponse xmlns:ns="http://services" xmlns:ax21="http://objects.services/xsd">
<ns:return xsi:type="ax21:ObjectMethod" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:defaultValue xsi:nil="true"/>
<ax21:fieldLength>9</ax21:fieldLength>
<ax21:fieldSubTypeId>0</ax21:fieldSubTypeId>
<ax21:fieldTypeId>20</ax21:fieldTypeId>
<ax21:isRequired>false</ax21:isRequired>
<ax21:label>Portfolio:</ax21:label>
<ax21:method>parentTypeId</ax21:method>
<ax21:methodId>114134</ax21:methodId>
<ax21:onInsert>true</ax21:onInsert>
<ax21:onSelect>true</ax21:onSelect>
<ax21:onUpdate>false</ax21:onUpdate>
<ax21:sequence>0</ax21:sequence>
</ns:return>
<ns:return xsi:type="ax21:ObjectMethod" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:defaultValue xsi:nil="true"/>
<ax21:fieldLength>12</ax21:fieldLength>
<ax21:fieldSubTypeId>0</ax21:fieldSubTypeId>
<ax21:fieldTypeId>31</ax21:fieldTypeId>
<ax21:isRequired>false</ax21:isRequired>
<ax21:label>Portfolio: Actual Cost - Direct</ax21:label>
<ax21:method>actualCostHere</ax21:method>
<ax21:methodId>114141</ax21:methodId>
<ax21:onInsert>false</ax21:onInsert>
<ax21:onSelect>true</ax21:onSelect>
<ax21:onUpdate>false</ax21:onUpdate>
<ax21:sequence>90</ax21:sequence>
</ns:return>
...
</ns:getPortfolioFieldsResponse>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.portfolioTypeId
- The ID corresponding to the portfolio type/category. The ID can be found by using getPortfolioTypes
.AxisFault
- thrown the session is invalid or if a Portfolio Type is not supported or a system error occured.public java.lang.Long createOrReplacePortfolio(java.lang.String sessionId, java.lang.Long portfolioTypeId, ValuePair[] valuePairs) throws AxisFault
As with all entities, certain fields are required when creating or updating a Portfolio.
These field values must be passed in as ValuePair
objects that
include the field ID and value. To determine required fields for a portfolio, go to Admin>Web Services API
in the Innotas application. Click the Portfolio Fields link and locate the required fields for insert/update.
If you do not pass in a portfolio ID, then a new portfolio is created. If you pass in a portfolio ID (11401 is the Portfolio ID field ID) as the first valuePairs element, it will search for the ID. If the ID does not exist, a new portfolio is created. If the portfolio ID does exist, then the existing portfolio is updated.
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services" xmlns:xsd="http://objects.services/xsd">
<soapenv:Header/>
<soapenv:Body>
<ser:createOrReplacePortfolio>
<ser:sessionId>dd0a31c7-1516-43b4-aab2-aef350104fba</ser:sessionId>
<ser:portfolioTypeId>8408709</ser:portfolioTypeId>
<ser:valuePairs>
<xsd:elementValue>207800705</xsd:elementValue>
<xsd:id>11401</xsd:id> <!--leave blank to create a new portfolio-->
</ser:valuePairs>
</ser:createOrReplacePortfolio>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned by the Login operation.portfolioTypeId
- The ID corresponding to the portfolio type/category. The ID can be found by using getPortfolioTypes
.
You can also find the type IDs in the Innotas app under Admin>Setup>Portfolios>Portfolio Categories.valuePairs
- Array of methodId-value pairs representing the field IDs/values for the portfolio. Use
getPortfolioFields
to discover the fields for
a particular portfolio type.AxisFault
- thrown the session ID is invalid, if a Portfolio Type is not supported, or a system error occured.public EntityHistory[] getDeleteHistory(java.lang.String sessionId, java.lang.Long entityTypeId, java.lang.String startYYYYMMDD, java.lang.String endYYYYMMDD, java.lang.String simpleDateFormat) throws AxisFault
EntityHistory
includes entity type ID, entity ID,
date modified, resource ID of user who made modification.
Note about start/end dates: If you enter the same date for start/end, for example 1/2/14-1/2/14, the system uses an implied timestamp of 1/2/2014 0:00:00 to 1/2/2014 23:59:59, and essentially returns all records for the day. However, if you enter start/end dates that cover more than one day, for example 1/2/14-1/3/14, then the system uses an implied timestamp of 00:00:00 for each date, resulting in records being returned from 1/2/14, but no records from 1/3/14. In order to return records from 1/3/14, you need to enter a date range of 1/2/14 - 1/4/14.
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:getDeleteHistory>
<ser:sessionId>2a5ff1e3-9405-4e67-a02a-07fc0767702b</ser:sessionId>
<ser:entityTypeId>54</ser:entityTypeId>
<ser:startYYYYMMDD>2001/01/11 14:25:00</ser:startYYYYMMDD>
<ser:endYYYYMMDD>2014/02/06 23:59:59</ser:endYYYYMMDD>
<ser:simpleDateFormat>yyyy/MM/dd HH:mm:ss</ser:simpleDateFormat>
</ser:getDeleteHistory>
</soapenv:Body>
sessionId
- The Session ID string returned from the Login operation.entityTypeId
- The ID of the entity type you are working with. For example, 5 for Task, 4 for Project, and so on.
Can be found in the Innotas app on Admin > Web Services API.startYYYYMMDD
- String representation of the start date of a period in the form yyyy/MM/dd. For example: January 11, 2001 is 2001/01/11.
If you want a different format, or wish to include a timestamp, you must use supply a format pattern with
the simpleDateFormat parameter (see below).endYYYYMMDD
- String representation of the end date of a period in the form yyyy/MM/dd.simpleDateFormat
- Applies a date format pattern to input dates. For example, if you want to
include a timestamp in your start/end dates, you would use the format: yyyy/MM/dd HH:mm:ss.AxisFault
- thrown if the session ID is invalid or a system error occured.public EntityHistory[] getUpdateHistory(java.lang.String sessionId, java.lang.Long entityTypeId, java.lang.String startYYYYMMDD, java.lang.String endYYYYMMDD, java.lang.Boolean showRepeatingPerDay, java.lang.String simpleDateFormat) throws AxisFault
EntityHistory
includes entity type ID, entity ID,
date modified, resource ID of user who made modification.
Note about start/end dates: If you enter the same date for start/end, for example 1/2/14-1/2/14, the system uses an implied timestamp of 1/2/2014 0:00:00 to 1/2/2014 23:59:59, and essentially returns all records for the day. However, if you enter start/end dates that cover more than one day, for example 1/2/14-1/3/14, then the system uses an implied timestamp of 00:00:00 for each date, resulting in records being returned from 1/2/14, but no records from 1/3/14. In order to return records from 1/3/14, you need to enter a date range of 1/2/14 - 1/4/14.
Example
soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:getUpdateHistory>
<ser:sessionId>9F98FC17CEFF0F4C6140039956CE96AF</ser:sessionId>
<ser:entityTypeId>54</ser:entityTypeId>
<ser:startYYYYMMDD>2013/09/12 14:25:00</ser:startYYYYMMDD>
<ser:endYYYYMMDD>2013/09/12 23:59:59</ser:endYYYYMMDD>
<ser:showRepeatingPerDay>true</ser:showRepeatingPerDay>
<ser:simpleDateFormat>yyyy/MM/dd HH:mm:ss</ser:simpleDateFormat>
</ser:getUpdateHistory>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned from the Login operation.entityTypeId
- The ID of the entity type you are working with. For example, 5 for Task, 4 for Project, and so on.
Can be found in the Innotas app on Admin > Web Services API.startYYYYMMDD
- String representation of the start date of a period in the form yyyy/MM/dd. For example: January 11, 2001 is 2001/01/11.
If you want a different format, or wish to include a timestamp, you must use supply a format pattern with
the simpleDateFormat parameter (see below).endYYYYMMDD
- String representation of the end date of a period in the form yyyy/MM/dd.showRepeatingPerDay
- Set to TRUE to view the date-time of each update per day. FALSE will display the last update in the day,
if there are multiple updates in one day.simpleDateFormat
- (Optional) Applies a date format pattern to input dates; default format is yyyy/MM/dd. For example, if you want to
include a timestamp in your start/end dates, you would use the format: yyyy/MM/dd HH:mm:ss.AxisFault
- thrown if the session ID is invalid or a system error occured.public Contour getContour(java.lang.String sessionId, java.lang.Long entityTypeId, java.lang.Long entityId, java.lang.String startDate, java.lang.String endDate) throws AxisFault
To get the entityId (allocation ID), use findEntity on entity 54 and specify the project ID from which you want the contours. This will return the allocation ID, plus whatever fields you specify. Take the return information and feed it into getContour.
To get resource capacity use entity type Id(11) and resource id as entity id
Below is an example of a getContour call:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:getContour>
<ser:sessionId>fa48197f-1b66-4872-817e-d7a4b54f2f30</ser:sessionId>
<ser:entityTypeId>54</ser:entityTypeId>
<ser:entityId>991588851</ser:entityId>
<ser:startDate>2014/01/01</ser:startDate>
<ser:endDate>2014/03/31</ser:endDate>
</ser:getContour>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned from the Login operation.entityTypeId
- Supports Allocated Role (54) only.entityId
- ID of the instance of the allocated role for which to get the contour.startDate
- (Optional) A string representation of a start date of a period in the form Year/Month/Day.
For example: January 11, 2001 is 2001/01/11endDate
- (Optional) A string representation of an end date of a period in the form Year/Month/Day.AxisFault
- thrown when the session ID is invalid, the entity type is invalid, or a system error occured.public long allocateContour(java.lang.String sessionId, java.lang.Long entityTypeId, java.lang.Long entityId, ContourEntry[] contourEntries) throws AxisFault
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services" xmlns:xsd="http://objects.services/xsd">
<soapenv:Header/>
<soapenv:Body>
<ser:allocateContour>
<ser:sessionId>16b74d98-9471-4276-be0c-13b3dbaa4fd1</ser:sessionId>
<ser:entityTypeId>54</ser:entityTypeId>
<ser:entityId>8599482</ser:entityId>
<ser:contourEntries>
<xsd:entryDate>2014/01/25</xsd:entryDate>
<xsd:entryHours>10</xsd:entryHours>
</ser:contourEntries>
<ser:contourEntries>
<xsd:entryDate>2014/01/26</xsd:entryDate>
<xsd:entryHours>8</xsd:entryHours>
</ser:contourEntries>
</ser:allocateContour>
</soapenv:Body>
</soapenv:Envelope>
Response:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:allocateContourResponse xmlns:ns="http://services">
<ns:return>810680715</ns:return>
</ns:allocateContourResponse>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned from the Login operation.entityTypeId
- Supports allocated role ID 54 only.entityId
- Unique ID of the allocated role. See Tips for Finding IDscontourEntries
- ContourEntry[] containing one or more date-hours pairs.
Dates format is yyyy/MM/dd. For example, 2001/01/11.AxisFault
- thrown if the session ID is invalid or a system error occured.public FinancialEntryContour getFinancialEntryContour(java.lang.String sessionId, java.lang.Long entityTypeId, java.lang.Long entityId, java.lang.String startDate, java.lang.String endDate) throws AxisFault
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:getFinancialEntryContour>
<ser:sessionId>9025bf8a-3c6c-4e69-b1ab-369b8294e4b7</ser:sessionId>
<ser:entityTypeId>300</ser:entityTypeId>
<ser:entityId>1957973625</ser:entityId>
<ser:startDate>01/01/2018</ser:startDate>
<ser:endDate>03/01/2018</ser:endDate>
</ser:getFinancialEntryContour>
</soapenv:Body>
</soapenv:Envelope>
Response:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:getFinancialEntryContourResponse xmlns:ns="http://services">
<ns:return xsi:type="ax21:FinancialEntryContour" xmlns:ax21="http://objects.services/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ax21:endEntryDate>03/01/2018</ax21:endEntryDate>
<ax21:entityId>1957973625</ax21:entityId>
<ax21:entityTypeId>300</ax21:entityTypeId>
<ax21:entries xsi:type="ax21:FinancialEntryContourEntry">
<ax21:amount>100.0</ax21:amount>
<ax21:periodDate>2018-01-01</ax21:periodDate>
</ax21:entries>
<ax21:entries xsi:type="ax21:FinancialEntryContourEntry">
<ax21:amount>200.0</ax21:amount>
<ax21:periodDate>2018-02-01</ax21:periodDate>
</ax21:entries>
<ax21:entries xsi:type="ax21:FinancialEntryContourEntry">
<ax21:amount>300.0</ax21:amount>
<ax21:periodDate>2018-03-01</ax21:periodDate>
</ax21:entries>
<ax21:startEntryDate>01/01/2018</ax21:startEntryDate>
</ns:return>
</ns:getFinancialEntryContourResponse>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned from the Login operation.entityTypeId
- Supports Finance entry type 300 only.entityId
- Unique ID of the finance entry.startDate
- (Optional) start date to limit the contour.endDate
- (Optional) end date to limit the contour.AxisFault
- thrown when the session ID is invalid, the entity type is invalid, or a system error occured.public long allocateFinancialEntryContour(java.lang.String sessionId, java.lang.Long entityTypeId, java.lang.Long entityId, FinancialEntryContourEntry[] contourEntries) throws AxisFault
sessionId
- entityTypeId
- entityId
- contourEntries
- AxisFault
public long getTeamMemberId(java.lang.String sessionId, long entityTypeId, long entityInstanceId, long resourceId) throws AxisFault
sessionId
- The Session ID string returned from the Login operation.entityTypeId
- The ID of the entity type you are working with. For example, 5 for Task, 4 for Project, and so on.
Can be found in the Innotas app on Admin > Web Services API.entityInstanceId
- The ID of the specific instance of the entity type.resourceId
- The ID of the resource.AxisFault
public EntityObj[] getMembers(java.lang.String sessionId, long parentTypeId, long parentId) throws AxisFault
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:getMembers>
<ser:sessionId>f6675d30-9c55-4b62-9438-d8fa5afaf80b</ser:sessionId>
<ser:parentTypeId>57</ser:parentTypeId>
<ser:parentId>1163210614</ser:parentId>
</ser:getMembers>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned from the Login operation.parentTypeId
- The ID of the entity type to get membership information for. Can be found in the Innotas app on Admin > Web Services API.parentId
- The ID of the specific instance of the entity type to get membership information for.AxisFault
- AxisFault thrown if the session ID is invalid, or if a system error occurred while retrieving membership data.public java.lang.Long createOrReplaceMember(java.lang.String sessionId, long parentTypeId, long parentId, long memberTypeId, long memberInstanceId, long profileId) throws AxisFault
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:createOrReplaceMember>
<ser:sessionId>f6675d30-9c55-4b62-9438-d8fa5afaf80b</ser:sessionId>
<ser:parentTypeId>57</ser:parentTypeId>
<ser:parentId>1163210614</ser:parentId>
<ser:memberTypeId>11</ser:memberTypeId>
<ser:memberInstanceId>1163210725</ser:memberInstanceId>
<ser:profileId>1163210573</ser:profileId>
</ser:createOrReplaceMember>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned from the Login operation.parentTypeId
- The ID of the entity type to add member to. Can be found in the Innotas app on Admin > Web Services API.parentId
- The ID of the specific instance of the entity type to add member to.memberTypeId
- The ID of the entity type of the member resource, group, or organization hierarchy unit to add to the entity.memberInstanceId
- The ID of the specific instance of the member type to add to the entity.profileId
- The ID of the permission profile to use to grant the member permissions on the entity or 0 to use the default team profile for the parent entity type.AxisFault
- AxisFault thrown if the session ID is invalid, or if a system error occurred while checking for an existing membership or persisting the membership,
or if parentTypeId refers to an entity type that is not supported by enterprise permissions.public java.lang.Boolean deleteMember(java.lang.String sessionId, long parentTypeId, long parentId, long memberTypeId, long memberInstanceId) throws AxisFault
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:deleteMember>
<ser:sessionId>f6675d30-9c55-4b62-9438-d8fa5afaf80b</ser:sessionId>
<ser:parentTypeId>57</ser:parentTypeId>
<ser:parentId>1163210614</ser:parentId>
<ser:memberTypeId>11</ser:memberTypeId>
<ser:memberInstanceId>1163210725</ser:memberInstanceId>
</ser:deleteMember>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned from the Login operation.parentTypeId
- The ID of the entity type to remove member from. Can be found in the Innotas app on Admin > Web Services API.parentId
- The ID of the specific instance of the entity type to remove member from.memberTypeId
- The ID of the entity type of the member resource, group, or organization hierarchy unit to remove from the entity.memberInstanceId
- The ID of the specific instance of the member type to remove from the entity.AxisFault
- AxisFault thrown if the session ID is invalid or if a system error occurred while checking for an existing membership or deleting the membership.public long getMemberId(java.lang.String sessionId, long entityTypeId, long entityInstanceId, long resourceId) throws AxisFault
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:getMemberId>
<ser:sessionId>?</ser:sessionId>
<ser:entityTypeId>?</ser:entityTypeId>
<ser:entityInstanceId>?</ser:entityInstanceId>
<ser:resourceId>?</ser:resourceId>
</ser:getMemberId>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- The Session ID string returned from the Login operation.entityTypeId
- The ID of the entity type. Can be found in the Innotas app on Admin > Web Services API.entityInstanceId
- The ID of the specific instance of the entity type.resourceId
- The ID of the resource or group.AxisFault
public long insertNote(java.lang.String sessionId, long parentEntityTypeId, long parentId, java.lang.String title, java.lang.String content) throws AxisFault
For example, if the parentEntityTypeId = 86 (status comment) and the parentId = statuscommentID, then newstatuscomment will be child of "parentID".
Or, if parentEntityTypeID = 4 (project) and parentId = projectID, then newstatuscomment will be a top level status comment.
There is a limit of 10k for note content.
sessionId
- The Session ID string returned from the Login operation.parentEntityTypeId
- The ID of the type of entity on which to associate the note. Can be project/issue/task,
an existing note, or a status comment. Note that the entity ID for a status comment is 86.parentId
- The ID of the instance of the entity type.title
- The title of the note.content
- The content of the note. Limit 10k of content.AxisFault
public ServerInfoResponse serverInfo(java.lang.String login)
public boolean moveTasks(java.lang.String sessionId, java.lang.Long targetEntityId, java.lang.Long targetEntityTypeId, java.lang.Long[] taskIds, java.lang.Long positionAfterTaskId) throws AxisFault
sessionId
- The Session ID string returned from the Login operation.targetEntityId
- The Id of the target entity (project or task) to which you are moving the task(s). Currently
project and task entities are supported.targetEntityTypeId
- The Id of the type of entity to which you are moving the task(s) - currently project
and task entity types are supported.positionAfterTaskId
- (Optional) The Id of the task you want to move the task(s) under.taskIds
- An array of task Ids that specify the tasks to move.AxisFault
public void init(ServiceContext serviceContext)
public void destroy(ServiceContext serviceContext) throws AxisFault
AxisFault
public long[] copyTasks(java.lang.String sessionId, java.lang.Long[] taskIds, java.lang.Long targetEntityId, java.lang.Long targetEntityTypeId, java.lang.Boolean copySubtasks, java.lang.Boolean copyTeam, java.lang.Boolean copyExpenses, java.lang.Boolean copySchedule, java.lang.Boolean copyAttachments, java.lang.Boolean copyNotes, java.lang.Boolean preserveHierarchyStructure) throws AxisFault
sessionId
- The Session ID string returned from the Login operation.targetEntityId
- The Id of target entity (project or task ) to which you are coping the tasktargetEntityTypeId
- The Id of the type of entity to which you are moving the task(s) - currently project
and task entity types are supported.taskIds
- An array of task Ids that specify the tasks to copycopySubtasks
- Boolean variable for copy sub task. Default is false.copyTeam
- Boolean variable is for copy the team while coping the task. Default is false.copyExpenses
- Copy expense is for copying the expanse of the task. Default is false.copySchedule
- Boolean variable is for copying the task schedule . Default is false.copyAttachments
- Boolean variable is for copying the task attachments. Default is false.copyNotes
- Boolean variable is for copying the task notes. Default is false.preserveHierarchyStructure
- Keep the hierarchy structure of the task to copied. Default is YESAxisFault
public EntityObj[] getRateTable(java.lang.String sessionId, java.lang.Long[] rateId, java.lang.String[] title) throws AxisFault
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:getRate>
<ser:sessionId>?</ser:sessionId>
<ser:rateIds>?</ser:rateIds>
<ser:titles>?</ser:titles>
</ser:getRate>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- Session IDrateId
- (Optional) array of Rate#getId()
title
- (Optional) array of Rate#getTitle()
AxisFault
public EntityObj[] getRate(java.lang.String sessionId, java.lang.Long rateId) throws AxisFault
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:getRate>
<ser:sessionId>?</ser:sessionId>
<ser:rateId>?</ser:rateId>
</ser:getRate>
</soapenv:Body>
</soapenv:Envelope>
</code>
sessionId
- Session IDrateId
- Rate Table ID.AxisFault
- on validation errors or if the rate table was not found.public java.lang.Long assignEntityToRate(java.lang.String sessionId, java.lang.Long entityTypeId, java.lang.Long entityId, java.lang.Long rateId, java.lang.String effectiveDateString) throws AxisFault
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:assignEntityToRate>
<ser:sessionId>?</ser:sessionId>
<ser:entityTypeId>11</ser:entityTypeId>
<ser:entityId>?</ser:entityId>
<ser:rateId>?</ser:rateId>
<ser:effectiveDateString>?</ser:effectiveDateString>
</ser:assignEntityToRate>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- Session IDentityTypeId
- Entity Type ID supported are Resource and Role.entityId
- Human Resource ID or Role IDrateId
- Rate Table IDeffectiveDateString
- Effective date of the resource to rate table association, cannot be more than 90 days in the past
supported formats MM/dd/yyyy
or ISO format yyyy-MM-dd
.AxisFault
- on validation exception or exception while inserting the association.public java.lang.Long createRateTable(java.lang.String sessionId, java.lang.String rateTitle, java.lang.String rateDescription, java.lang.Double opexRate, java.lang.Double capexRate, java.lang.String currencyCode) throws AxisFault
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:createRateTable>
<ser:sessionId>?</ser:sessionId>
<ser:rateTitle>?</ser:rateTitle>
<ser:rateDescription>?</ser:rateDescription>
<ser:opexRate>?</ser:opexRate>
<ser:capexRate>?</ser:capexRate>
<ser:currencyCode>?</ser:currencyCode>
</ser:createRateTable>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- Session IDrateTitle
- cannot be null or empty cannot exceed 200 charactersrateDescription
- (Optional), cannot exceed 4000 charactersopexRate
- operational expenditure rate.capexRate
- (Optional) Used if organization uses a separate Capitalized expenditure rate.currencyCode
- (Optional) A 3 character currency code for the desired tt.busobj.CustomerCurrency
to use for this new Rate Table. If none is specified, then the organization currency
will be used.AxisFault
- on validation exception or issues creating the rate table.public java.lang.Long createRate(java.lang.String sessionId, java.lang.Long rateId, java.lang.Double opexRate, java.lang.Double capexRate, java.lang.String effectiveDateString) throws AxisFault
createRateTable(String, String, String, Double, Double, String)
additional Rates may be added to the table that will change the rate using the supplied effective date.
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:createRate>
<ser:sessionId>?</ser:sessionId>
<ser:rateId>?</ser:rateId>
<ser:opexRate>?</ser:opexRate>
<ser:capexRate>?</ser:capexRate>
<ser:effectiveDateString>?</ser:effectiveDateString>
</ser:createRate>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- Session IDrateId
- Rate Table ID to add this rate to.opexRate
- operational expenditure rate.capexRate
- (Optional) Used if organization uses a seperate Capitailized expenditure rate.effectiveDateString
- Effective date of the new rate supported formats MM/dd/yyyy
or ISO format yyyy-MM-dd
.AxisFault
- on any validation errors or exceptions encountered in the creation.public java.lang.Long createCustomRateTable(java.lang.String sessionId, java.lang.Long entityTypeId, java.lang.Long entityId, java.lang.String rateTitle, java.lang.Double opexRate, java.lang.Double capexRate, java.lang.String effectiveDateString, java.lang.String currencyCode) throws AxisFault
ServiceConstants#ROLE
or ServiceConstants#RESOURCE
and the ID of the entity and associates
it with a custom rate table (a rate table that is only for this resource/role).
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services">
<soapenv:Header/>
<soapenv:Body>
<ser:createCustomRateTable>
<ser:sessionId>?</ser:sessionId>
<ser:entityTypeId>?</ser:entityTypeId>
<ser:entityId>?</ser:entityId>
<ser:rateTitle>?</ser:rateTitle>
<ser:opexRate>?</ser:opexRate>
<ser:capexRate>?</ser:capexRate>
<ser:effectiveDateString>?</ser:effectiveDateString>
<ser:currencyCode>?</ser:currencyCode>
</ser:createCustomRateTable>
</soapenv:Body>
</soapenv:Envelope>
sessionId
- Session ID.entityTypeId
- supports either com.innotas.api.util.ServiceConstants#RESOURCE
or com.innotas.api.util.ServiceConstants#ROLE
entityId
- Entity ID to associate the new custom rate with.rateTitle
- Rate Title.opexRate
- operational expenditure rate.capexRate
- (Optional) Used if organization uses a separate Capitalized expenditure rate.effectiveDateString
- Effective date of the new rate supported formats MM/dd/yyyy
or ISO format yyyy-MM-dd
.currencyCode
- (Optional) A 3 character currency code for the desired tt.busobj.CustomerCurrency
to use for this new Rate Table. If none is specified, then the organization currency
will be used.AxisFault
- on validation error or exception during association.public DashboardMetadata getDashboardMetadata(java.lang.String sessionId, long dashboardId) throws AxisFault
sessionId
- Session IDdashboardId
- Dashboard IDAxisFault
public java.lang.String runDashboard(java.lang.String sessionId, long dashboardId, java.lang.String username, java.lang.String token, java.lang.String rerun) throws AxisFault
sessionId
- Session IDdashboardId
- Dashboard IDusername
- Deprecated. Innotas username used for login. This is optional, but if include, must also have a valid tokentoken
- Deprecated. Token generated in the user preference. This is optional, but if include, must also have a valid usernamererun
- true forces dashboard to re-runAxisFault
- when the dashboard can't be runpublic java.lang.String getOdataUrl(java.lang.String sessionId, long dashboardId) throws AxisFault
sessionId
- Session IDdashboardId
- Dashboard IDAxisFault
- when trying to access a running dashboard or other retrieval exception