Where can I find API URLs and WSDL for my environment?
Environment:
All versions of Oracle Field Service (OFS)
Issue:
I can not find correct API URLs for our integrations
Resolution:
API URL
Below is a list of available APIs for Oracle Field Service (OFS).
APIs are available based on the Oracle Field Service services your organization purchased.
- Capacity API is available if your organization purchased Oracle Field Service Capacity Cloud Service (Capacity)
- Location API is available if your organization purchased Oracle Field Service Smart Location Cloud Service (Smart Location)
- All other APIs are available with Oracle Field Service Core Manage Cloud Service
You should use the latest API version to ensure release compatibility. This also allows you to take advantage of the functionality available in that release.
APIs should be accessed using https://<instance_name>.etadirect.com/soap/{API_NAME}/{version}/
Where:
{API_NAME} - This is the API you are going to use.
<instance_name> - The Oracle assigned Instance Name that is defined in Your Provisioned Instances in the Cloud Portal found on the Service Console. This name begins with ‘ofsc'. If the Instance Name in the Service Console is 'ofsc-1111', the API URL would be 'ofsc-1111.etadirect.com'.
API VERSIONING
API versioning was added in ETAdirect 4.5.12. All the APIs have an alternative URL that does not include the version. This URL is always equivalent to version 1, for example:
/soap/capacity/ is the same as /soap/capacity/v1/
Whenever any change is done to the API WSDL or its behavior, we increment an API version. The API versions are always of form {v1, v2, v3, ...}. The API versions do not correspond to versions of $OFS or any other product.
API WSDL
For SOAP APIs, the WSDL is available by adding "?wsdl" to the end of the full API URL. e.g. when URL is listed as /soap/inbound/v1/, the WSDL is available at https://<instance_name>.etadirect.com/soap/inbound/v1/?wsdl
The WSDL URLs look like:
https://<instance_name>.etadirect.com/soap/{API_NAME}/{version}/?wsdl
More details about specific APIs and their versions can be found within their SDK documentation available here:
https://docs.oracle.com/cloud/latest/fieldservicecs_gs/docs.htm
|
Name |
URL / API Version |
Added in Release |
Deprecation or Planned Announcement |
Removed or Planned Removal |
Type |
|---|---|---|---|---|---|
|
Core API |
/rest/OFSCore/v1/ |
16.2 |
|
|
REST |
|
Metadata API |
/rest/OFSMetadata/v1/ |
16.2 |
|
|
REST |
|
Inbound API |
/soap/inbound/v1/ |
<4.4 |
|
|
SOAP |
|
Outbound API |
/soap/outbound/v1/ |
<4.4 |
|
|
SOAP |
|
Activity Management API |
/soap/activity/v1/ |
<4.4 |
15.8 |
17.2 |
SOAP |
|
|
/soap/activity/v2/ |
4.5.15 |
15.8 |
17.2 |
SOAP |
|
|
/soap/activity/v3/ |
15.8.0 |
16.8 |
20C |
SOAP |
|
Mobile Client API |
/soap/mobile-client/v1/ |
< 4.4 |
15.8 |
17.2 |
SOAP |
|
|
/soap/mobile-client/v2/ |
4.5.15 |
15.8 |
17.2 |
SOAP |
|
|
/soap/mobile-client/v3/ |
15.8.0 |
16.8 |
17.2 |
SOAP |
|
Resource Management API |
/soap/resource-management/v1/ |
< 4.4 |
15.8 |
17.2 |
SOAP |
|
|
/soap/resource-management/v2/ |
4.5.15 |
15.8 |
17.2 |
SOAP |
|
|
/soap/resource-management/v3/ |
15.8.0 |
16.8 |
20C |
SOAP |
|
Capacity Management API |
/soap/capacity/v1/ |
<4.4 |
|
|
SOAP |
|
Positioning API |
/soap/positioning/v1/ |
<4.4 |
|
|
SOAP |
|
Location API |
/soap/location/ v1/ |
4.4 |
18C |
20C |
SOAP |
|
Parts Catalog API |
/soap/parts-catalog/v1/ |
4.5.12 |
16.8 |
17.8 |
SOAP |
|
|
/soap/parts-catalog/v2/ |
4.5.14 |
|
|
SOAP |
|
External Trigger API |
/rest/external-trigger/v1/ |
<4.4 |
16.2 |
17.8 |
REST |
|
History API |
/rest/history/v1/ |
4.5.12 |
19A |
20C |
REST |
* Note: APIs may not be available until your instances are updated.
