The Innotas operation defines how to interact with your Service Desk data. The operation represents a specific action (e.g., Create, Delete, Get, etc.) to be performed against a specific Innotas record type or object (e.g., Project, Account, Resource, etc.). Not all actions are available for every object. You will need to create a separate operation component for each action/object combination required for your integration. The operation browses your object definitions in real time to get any custom fields you may have defined.
Options Tab
Available Actions: The Innotas operation supports the following types of actions:
- CREATE - Used to create multiple records.
- DELETE - Used to delete multiple records.
- GET - Used to retrieve a single record by its ID; you can enter only one ID.
- QUERY - Used to search for data; filters (search parameters) can be used.
- UPDATE - Used to update multiple records.
- UPSERT - Used to update multiple records if they exist. If the records do not exist it creates them.
- EXECUTE - Used for all other "procedural" API calls.
Import Wizard: The Import Wizard shows you how to define the object you are integrating. It is required that you click the Import button and follow the wizard to successfully configure an operation and automatically generate the Response XML profile that can include all required base and custom fields.
Standard Fields: This table describes the default field definitions.
| Field Name |
Description |
Action |
| Object |
Displays the object you selected in the Import Wizard. |
Available for all actions. |
| Return Application Error Responses |
Check box that defines whether to forward responses through the process or fail at the Connector level. If checked, failed operations will not be reported on the Manage menu, allowing you to act on them in your process. |
Available for all actions. |
| Request Profile |
The XML profile definition that represents the XML structure that is being sent to the Connector. |
Available for CREATE, DELETE, EXECUTE, UPDATE and UPSERT. |
| Find Entity by Filter |
If selected on the QUERY action, allows you to select search parameters. |
Available for QUERY. |
CREATE, DELETE, GET, UPDATE and UPSERT
The following objects are available when you use the CREATE, DELETE, GET, UPDATE and UPSERT actions.
| Object Name |
Object ID |
| Account |
12 |
| Allocated Role |
54 |
| Issue |
6 |
| Program |
3 |
| Project Role |
47 |
| Project |
4 |
| Resource |
11 |
| Task Role |
52 |
| Task Schedule |
79 |
| Task |
5 |
| Team Member |
53 |
| User |
23 |
QUERY
When using the QUERY action you can search for the same objects available with the CREATE action, or you can use filters (search parameters) which give you access to more objects.
To enable filters, select the "Find entity by filter" check box. When the profile is generated, only fields that can be queried are listed. In addition:
- Only the "=" operator is supported.
- Only the "AND" operand is supported.
- Nested conditions are not supported.
With filters enabled you can filter on the following objects.
| Object Name |
Object ID |
| Business Unit |
2 |
| Contact |
19 |
| Expense Entry |
71 |
| Expense Manager |
22 |
| Fixed Bid Invoice |
68 |
| Fixed Bid Invoice Item |
69 |
| HR Issue |
97 |
| Issue |
6 |
| Org Role Demand |
138 |
| Organization |
38 |
| Portfolio |
114 |
| Program |
3 |
| Project |
4 |
| Project Role |
47 |
| Project Role Demand |
136 |
| Project Role Demand by Portfolio |
139 |
| Request |
96 |
| Resource |
11 |
| Resource Allocation by Project Role |
135 |
| Resource Capacity |
137 |
| Resource Schedule by Task Role |
134 |
| Resource Time Summary |
148 |
| Scoring Profile |
152 |
| Summary Task |
13 |
| Task |
5 |
| Task Role |
52 |
| Task Schedule |
79 |
| Timesheet |
20 |
| Timesheet Entry |
66 |
| User |
23 |
Fields Configuration
On the Fields tab, you can clear the fields that you do not want returned in the response. All fields are checked by default. To quickly select or clear all the fields for a given object, click the check box next to the object's name at the top of the field list.
Innotas supports regular fields and user-defined fields. User-defined fields have a <method> that always begins with "UDF" and a <methodId> consisting of a minimum of 6 digits.
EXECUTE
The following objects are available only when you use the EXECUTE action.
| Object Name |
Object ID |
| Skill Set |
37 |
| Timesheet |
20 |
The following categories of objects are also available when you use the EXECUTE action.
Request:
- createOrReplaceRequest
- getRequestFields
- getRequestTypes
- submitRequest
- submitRequests
Resource:
- allocateResourceTime
- createOrReplaceResourceProfileSetting
- getResourceProfileSetting
Timesheet:
- approveTimesheet
- createOrReplaceTimesheetEntries
- createOrReplaceTimesheets
- deleteTimesheetEntries getTimesheet
- getTimesheetForUser
- getTimesheetForUsers
- getTimesheets
- getTimesheetVariables
- submitTimesheet
- submitTimesheets
- updateTimesheetEntries
Portfolio:
- createOrReplacePortfolio
- getPortfolioFields
- getPortfolioTypes
Skill Categories:
Miscellaneous:
- getDeleteHistory
- getUpdateHistory
- getListValues
Archiving Tab
Click here for more information on Archiving.
This page
Other pages
Account
