I'm trying to determine whether AI Scheduler Technician Requirements are accessible and editable via the Simpro REST API.
My goal is to bulk manage Technician Requirements on Jobs without using the UI.
The Technician Requirements section contains:
Role Type
Qty
Skills
Licences
Estimated Time (hrs)
Example requirement:
Role Type: Technical Service Support
Qty: 1
Licence: Fire Extinguisher Training
Estimated Time: 5 Hours
While inspecting the web UI, I found Technician Requirements being submitted as:
techReqRowId[0]
techReqRole[0]
techReqQty[0]
techReqSkillIds_0
techReqLicenceIds_0
techReqEstimatedTime[0]
Example values:
techReqRowId[0]=134
techReqRole[0]=Technical Service Support
techReqQty[0]=1
techReqSkillIds_0=[]
techReqLicenceIds_0=[3]
techReqEstimatedTime[0]=5
I have queried the following REST endpoints:
GET /api/v1.0/companies/{companyID}/jobs/{jobID}
GET /api/v1.0/companies/{companyID}/jobs/{jobID}/sections/
GET /api/v1.0/companies/{companyID}/jobs/{jobID}/sections/{sectionID}
GET /api/v1.0/companies/{companyID}/jobs/{jobID}/sections/{sectionID}/costCenters/{costCenterID}
None of these expose anything related to:
Technician Requirements
Role Type
Skills
Licences
Estimated Time
AI Scheduler
The Job endpoint only returns assigned technicians:
"Technicians": []
"Technician": {}
I also found and successfully queried the documented AI Scheduler catalogue endpoints:
GET /api/v1.0/companies/{companyID}/setup/labor/licences/
GET /api/v1.0/companies/{companyID}/setup/labor/skills/
The licence IDs returned by the API exactly match the IDs used by Technician Requirements in the UI.
For example:
techReqLicenceIds_0=[3]
matches:
ID 3 = Fire Extinguisher Training
This suggests that Skills and Licences are exposed through the REST API, but I have not been able to find an endpoint exposing the actual Technician Requirement assignments.
My question is:
Is there currently a REST API endpoint that exposes Technician Requirements for a Job, Section, Cost Centre, Work Order, or AI Scheduler object?
Specifically I am looking for API access to:
Role Type
Qty
Skills
Licences
Estimated Time
Has anyone found a supported endpoint for this, or are Technician Requirements currently only available through the web application? We plan to use the AI scheduler for mass job planning but defeats the purpose if we have such high job volume and difference in time to complete.
Thanks in advance.
AI Scheduler Technician Requirements - Is There a REST API Endpoint?
Forum rules
- Check the documentation first. Before posting questions, please check the documentation to ensure it doesn't already cover what you need.
- No spam. All automated messages, advertisements, and links to competitor websites will be deleted immediately.
- Post in relevant sub-forums only. Messages posted in the wrong topic area will be removed and placed in the correct sub-forum by moderators.
- Respect other users. No flaming or abusing fellow forum members. Users who continue to post inflammatory, abusive comments will be deleted from the forum after two warnings are issued by moderators.
- Harassment. No threats or harassment of other users will be tolerated. Any instance of threatening or harassing behavior is grounds for deletion from the forums.
- Adult content. No profanity or pornography is allowed. Posts containing adult material will be deleted.
- Bandwidth. All images and signatures must be 500 x 500 pixels or smaller. Posts containing over-sized images and signatures will be removed.
- Illegal content. No re-posting of copyrighted materials or other illegal content is allowed. Any posts containing illegal content or copyrighted materials will be deleted.
-
SimproAPITeam
- Posts: 831
- Joined: Wed May 01, 2024 2:31 am
Re: AI Scheduler Technician Requirements - Is There a REST API Endpoint?
Hi,
Thanks for the detailed investigation. Your conclusion is correct: Technician Requirements are not currently exposed by the REST API, for reading or writing.
The two catalog endpoints you found, setup/labor/skills and setup/labor/licences, are the correct ones, and the IDs they return are the same IDs the requirements store internally.
Kind regards
Thanks for the detailed investigation. Your conclusion is correct: Technician Requirements are not currently exposed by the REST API, for reading or writing.
The two catalog endpoints you found, setup/labor/skills and setup/labor/licences, are the correct ones, and the IDs they return are the same IDs the requirements store internally.
Kind regards
Simpro API Team | Simpro Software Group
Re: AI Scheduler Technician Requirements - Is There a REST API Endpoint?
Thanks for getting back to me, Is there plans to expose this as accessible by API? Is there any way you could recommend accessing this job setting in bulk?
-
SimproAPITeam
- Posts: 831
- Joined: Wed May 01, 2024 2:31 am
Re: AI Scheduler Technician Requirements - Is There a REST API Endpoint?
Hi Khan,
Some new endpoints related to the AI scheduler function has been released and can be found in our documentation.
Most of the setup is under Sites such as restricted technicians, skills and licences. Found here
https://developer.simprogroup.com/apido ... ite-Skills
There are also added functionality to update skills on contractors and employees
https://developer.simprogroup.com/apido ... yee-Skills
For licence and skill setup see more info here.
https://developer.simprogroup.com/apido ... d-Licences
All these require the AI scheduler to be active on your build to be available.
Regards
Some new endpoints related to the AI scheduler function has been released and can be found in our documentation.
Most of the setup is under Sites such as restricted technicians, skills and licences. Found here
https://developer.simprogroup.com/apido ... ite-Skills
There are also added functionality to update skills on contractors and employees
https://developer.simprogroup.com/apido ... yee-Skills
For licence and skill setup see more info here.
https://developer.simprogroup.com/apido ... d-Licences
All these require the AI scheduler to be active on your build to be available.
Regards
Simpro API Team | Simpro Software Group
DEVELOPER CENTER