DEVELOPER CENTER
i am aware that the simpro api docs list an entities required fields, but companies can also add on their own required fields like due date etc.
as per the docs, for a job the only required fields are TYPE and SITE, but in fact, if a company has customised this they may also require DUE DATE for example.
Is there a API method to enumerate a companies specific list of required attributes per entity rather than going off the api docs?
Of course you coudl brute force entity creation but preferably there is a GET method?
thanks
finding required fields
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: finding required fields
Hey Owen,
If additional fields such as Due Date are required when creating a job, this is usually the result of the company’s system setup (Mandatory Due Date on creation is enabled in this case), rather than something defined at the API schema level.
Currently, there isn’t a GET endpoint available to retrieve a company-specific list of required attributes for an entity via the API.
Hope this helps,
Regards
If additional fields such as Due Date are required when creating a job, this is usually the result of the company’s system setup (Mandatory Due Date on creation is enabled in this case), rather than something defined at the API schema level.
Currently, there isn’t a GET endpoint available to retrieve a company-specific list of required attributes for an entity via the API.
Hope this helps,
Regards
Simpro API Team | Simpro Software Group