FieldOps API FAQs
Frequently Asked Questions related to the FieldOps API.
We are able to upload a file with the API but we cannot process the file, why?
The API allows you to upload a file to an account on the FieldOps Portal.
Currently, the account user will still need to log in and start processing a file from within the FieldOps Portal.
The ability to allow file processing through the API is on our roadmap for future releases.
How long does it take for my app to be given access to the APIs that I requested?
After adding your app and agreeing to the terms and conditions, you immediately have access to the FieldOps APIs in the Staging environment. There is no delay.
For more details, please view Token Authentication.
How can I get access to APIs after registering my company?
Follow our Get Started guide to register an application.
I am getting an HTTP 400 error after creating the account on the CONNECT
portal. How do I resolve this?
Activate the account on the farm portal by clicking on the farm button on the left panel on the FieldOps Portal.
I am getting a 401 'Unauthorized' response. How do I resolve this?
Check the following:
- Check the endpoint parameters.
- User credentials are correct. Login to the FieldOps Portal to verify they allow you to log in.
- Check that the Subscription Key value is correct for the Applictaion and Environment.
If still experiencing the error, you can raise a ticket by going to Account > Support Ticket.
Are data files and task files the same?
No. Task files are child files of the data that is put into the system. All the files are stored at the same location, but the task files have a parent ID. The ingested files do not have a parent ID.
Task data is kept in smaller chunks of task files. So an ingested file can have multiple child task files.
GetFiles
will retrieve all the files in the system and GetTasks
will retrieve files for a particular task.
What request rate limits apply to the FieldOps API?
The FieldOps API has a request rate limit of 120 concurrent users. If a user exceeds a rate limit of 120 requests per second, then the response will be a 429 error with response: Rate limit is exceeded. Try again later.
What is the token expiration time for the production and stage environments?
Refer to the table below:
API | Environment | Expiration |
---|---|---|
FieldOps API | Production | 3600 seconds |
FieldOps API | Staging | 21600 seconds |