General REST API guidelines
This section provides answers to frequently asked questions (FAQs) about REST API.
I followed the steps to configure Jetty for using HTTPs, but the REST API does not work. How do I proceed?
Restart the AR System server after updating the jetty-selector.xml file.
Which client type does the REST API use?
The REST API is a transport mechanism and not a specific client-type. The REST API client identifies itself as a specific client type using the HTTP header X-AR-Client-Type.
How long is the authentication token valid?
The default time for token authentication is 3600 seconds (or 1 hour), but it is controlled by the AR_SERVER_INFO_EA_SYNC_TIMEOUT configuration setting. This setting used to determine how long the AR System server can validate a user’s password against a copy in the cache, instead of checking an external authentication server (LDAP).
Comments
Hi, we cannot see the video referring to in "The video helps you in understanding...". May be due missing permission settings? Thanks, Rudolf
Hello Rudolf,
The link to the video is updated on the BMC Remedy AR System REST API overview topic.
Thanks,
Prachi
Hi, We observed that any user can extract complete data using REST API, if user has link of form. Is there a way to restrict the data simply by User access in User form/People Form.
Thanks, Ankur
Hello Ankur,
Remedy REST API works as a transport layer. The user access roles and permissions are handled by the AR System server.
To better understand your issue, could you please provide the steps you are performing or the environment where you are facing this issue.
Regards,
Anagha