Active with remarks |
---|
This application needs additional settings. Please follow the documentation below to create your own connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). More. |
The Odyssee Field Service modulesThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) More allow you to watch, create, update, list, retrieve, and delete the tasks, articles, contacts, and companies, in your Odyssee Field Service account.
Prerequisites
-
An Odyssee Field Service account
In order to use Odyssee Field Service with Boost.spaceCentralization and synchronization platform, where you can organize and manage your data. More IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. More, it is necessary to have an Odyssee Field Service account. If you do not have one, you can create an Odyssee Field Service account at odysseefieldservice.com.
To connect your Odyssee Field Service account to Boost.space Integrator you need to obtain the API Key from your Odyssee Field Service account and insert it in the Create a connection dialog in the Boost.space Integrator moduleThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) More.
1. Log in to your Odyssee Field Service account.
2. Click Connectors () > Odyssee API > Install > + Icon
3. Enter the details for API Key. Click Save and Copy.
Name |
Enter the name you provided when creating the Odyssee Field Service account. |
UserCan use the system on a limited basis based on the rights assigned by the admin. More Name |
Enter your Odyssee Field Account’s username. |
Password |
Enter your Odyssee Field Account’s username. |
Key |
This field auto-populates when you enter the above details. |
4. Go toBoost.space Integrator and open the Odyssee Field Service module’s Create a connection dialog.
5. In the Connection name field, enter a name for the connection.
6. In the API Key field, enter the API key copied in step 3, and click Continue.
The connection has been established.
TriggersEvery scenario has a trigger, an event that starts your scenario. A scenario must have a trigger. There can only be one trigger for each scenario. When you create a new scenario, the first module you choose is your trigger for that scenario. Create a trigger by clicking on the empty module of a newly created scenario or moving the... when a new task is created.
Connection |
Establish a connection to your Odyssee Field Service account. |
Limit |
Set the maximum number of new tasks Boost.space Integrator should return during one scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive. More execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
Fetches all of the tasks.
Retrieves a task.
Creates a new task.
Connection |
Establish a connection to your Odyssee Field Service account. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Task Type |
Select the task type you want to create:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Task Type ID |
Select the Task Type ID:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Task Type Code |
Select the task type code. For example, order parts. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Task Type Object |
Add the task type objects:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Task Priority |
Select the Task priority:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Task Priority ID |
Select the Task Priority ID:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Task Priority Code |
Select the task priority code. For example, |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Task Priority Object |
Add the task type objects:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Company |
Select the option for the company details and enter the information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Sales Territory |
Select the option for the sales territory and enter the information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Sales Organization |
Select the option for the sales territory and enter the information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Is Client |
Select whether this task is for a client. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Is Supplier |
Select whether this task is for a supplier. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Archived |
Select whether this task is archived. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Notes |
Enter any additional information about the task. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Marketing Segment |
Select the option for entering the marketing segment details and enter the information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Company Sales StatusCreate statuses for each module separately to create an ideal environment for efficient and consistent work. More Code |
Select the company sales status code for the task:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
VAT Reg Code |
Enter the organization’s VAT Reg Code. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Is Working Address |
Select whether this is the working address. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parent Company |
Select the option for the parent company details and enter the information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Phone |
Enter the company’s phone number. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Fax |
Enter the company’s fax number. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Website URL |
Enter the company’s website URL address. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Enter the company’s email address. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Street |
Enter the company’s street name. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Street Number |
Enter the company’s street number. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
City |
Enter the company’s city name. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
ZIP Code |
Enter the company’s area ZIP or postal code. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Country ID |
Select the country ID of the company. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Fee List Select |
Select the fee list applicable to the task. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Company Type Select |
Select the option for the company sector and enter the information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Language ID |
Select the Language ID applicable to the company. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Language Code |
Enter the language code applicable to the company. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Code |
Enter the task code for the company. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Article Price List Select |
Select the option for the article price list details and enter the information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Article Price LabelA label is a “tag” that can be added to items within a module. It's a flexible tool used to categorize and organize data, making it easier to customize workflows and processes. More Code |
Select the option for the article price label details and enter the information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Payment Method Select |
Select the option for the payment method and enter the information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Company Sector Select |
Select the option for the company sector and enter the information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Is Lead |
Select whether this task from a lead. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Is Subcontractor |
Select whether this task from a subcontractor. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Latitude |
Enter the company’s location latitude details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Longitude |
Enter the company’s location longitude details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Street 2 |
Enter the company’s street address. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
BIC Code |
Enter the company’s BIC code details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Specialties |
Enter the company specialties into which does its business. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Register Number |
Enter the company’s registration number details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Register City |
Enter the city in which the company is registered. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bank Account |
Enter the company’s bank account details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Mobile |
Enter the company’s mobile number. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Service ManagerCan manage members and space managers, view and manage items. Can modify space settings. More Select |
Select the option for the service manager and enter the information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Finance Manager Select |
Select the option for the finance manager and enter the information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Account Manager Select |
Select the option for the account manager and enter the information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Subject |
Enter the subject line of the task. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Task Status |
Select the option to choose task status:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Table ID |
Foreign key to the table that is linked to this task using GUID. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Table Name |
Foreign key to the table that is linked to this task using table name. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Table |
Foreign key of the object that is linked to this task using GUID Primary Key. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Remark |
Enter any comments you would like to mention for the task. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Customer Reference |
Enter the customer reference details for the task. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Assigned to User ID |
Enter the User ID to whom the task is assigned. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Assigned to User Group ID |
Enter the User Group ID to which the task is assigned. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Date Start |
Enter the date when the work on the task started. See the list of supported date and formats. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Due Date |
Enter the date when the task must be completed. See the list of supported date and formats. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Date Closed |
Enter the date when the task is completed. See the list of supported date and formats. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Archived |
Select whether the task is archived. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Date Assigned |
Enter the date and time when the task has been assigned to a specific user. See the list of supported date and formats. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Date Suggested by Company |
Enter the date suggested by the company to start working on this task. See the list of supported date and formats. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Internal ID |
Enter the Internal ID of the task for internal reference. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Reference Back Office |
Enter the back office reference details for the task. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Contact Select |
Select the option to choose the contact for the task and enter the details:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request by Company |
Select the option to choose the company which has requested the task:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Company ID |
Select the company ID which has requested the task. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Company Code |
Enter the company code which has requested the task. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bill to Party |
Select the company to which the task will be billed. |
Updates a task.
Connection |
Establish a connection to your Odyssee Field Service account. |
Task ID |
Select the Task ID whose details you want to update. |
See the Create a Task for field descriptions.
Triggers when a new article is created.
Fetches all of the articles.
Retrieves an article.
Creates a new article.
Updates an article.
Connection |
Establish a connection to your Odyssee Field Service account. |
Article ID |
Select the Article ID whose details you want to update. |
See the Create an Article for field descriptions.
Triggers when a new company is created.
Fetches all of the companies.
Retrieves a company.
Creates a new company.
Updates a company.
Connection |
Establish a connection to your Odyssee Field Service account. |
Company ID |
Select the Company ID whose details you want to update. |
See the Create a Company for field descriptions.
Triggers when a new contact is created.
Fetches all of the contacts.
Retrieves a contact.
Creates a new contact.
Connection |
Establish a connection to your Odyssee Field Service account. |
Company Select |
Select the option to choose the company for which you want to create the contact:
|
Company ID |
Select the Company ID for which you want to create the contact. |
Company Code |
Select the company code for which you want to create the contact. |
Last Name |
Enter the contact’s last name. |
First Name |
Enter the contact’s first name. |
Language ID |
Select the contact’s preferred Language ID. |
Language Code |
Select the contact’s preferred language code. |
Archived |
Select whether the contact is archived. |
FunctionsFunctions you can use in Boost.space Integrator - create, update, delete, get, search. |
Enter the contact’s job responsibilities. |
Login |
Enter the login details of the contact. |
Password |
Enter the contact’s login password. |
Notes |
Enter any additional details about the contact that you would like to mention. |
Birthdate |
Enter the contact’s date of birth. |
Phone |
Enter the contact’s phone number. |
Mobile |
Enter the contact’s mobile number. |
|
Enter the contact’s email address. |
Skype |
Enter the contact’s Skype ID details. |
Private Phone |
Enter the contact’s private phone number. |
Private Mobile |
Enter the contact’s private mobile number. |
Private Email |
Enter the contact’s private email address. |
Reference Back Office |
Enter the contact’s back-office reference details. |
Updates contact.
Connection |
Establish a connection to your Odyssee Field Service account. |
Contact ID |
Select the Contact ID whose details you want to update. |
See the Create a Contact for the field descriptions.
Performs an arbitrary authorized API call.
Connection |
Establish a connection to your Odyssee Field Service account. |
URL |
Enter a path relative to For the list of available endpoints, refer to the Odyssee Field Service API Documentation. |
Method |
Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry. |
Headers |
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you. |
Query String |
Enter the request query string. |
Body |
Enter the body content for your API call. |
The following API call returns all the articles from your Odyssee Field Service account:
URL:
/Article
Method:
GET
Matches of the search can be found in the module’s Output under BundleA bundle is a chunk of data and the basic unit for use with modules. A bundle consists of items, similar to how a bag may contain separate, individual items. More > Body > value.
In our example, 13 articles were returned: