![]() These filters all operate as query parameters:Īll filters accept multiple values, which can be passed in by using multiple query parameters with the same name: The documentation indicates which endpoints support which filters. This can make it easier to process the results if the client is only looking for specific resources, and it can also speed up the response. It is possible to filter the results on endpoints that return a list of resources. Clients can access verbose properties by adding Verbose=true to the request query parameters. The endpoints with a verbose mode, and which additional fields are available, are indicated in the documentation. Some endpoints have a verbose mode which returns additional fields and related resources, but which may take longer to execute. These legacy ID values will be deprecated in the future but, for now, are included to help migrate from older API versions. Simply add CTLegacyScramble=true to the request query parameters to access the LegacyID field. Resource IDs will be in the format of a modern entity scramble (starting with a 4), but the legacy short scramble IDs (starting with a 2) are also available where indicated by the documentation. ![]() In order to guarantee compatibility, all dates should be in the format YYYY-MM-DD (e.g. Some requests make use of dates, either in the URL or in the body of a POST/PATCH request. Currently the only supported content type is application/json, resulting in the following header: ![]() For example, get a list of people from your ClickTime account by making the request below, substituting " API_TOKEN" with your actual API token you received from the request above.Īll requests should include an appropriate Content-Type header. The example requests above will return various information including the API token you can use to make subsequent requests to other endpoints. Tokens can also be manually invalidated and regenerated using the “My Preferences” page or the “Me/ResetAuthToken” endpoint. These tokens may be subject to invalidation for other reasons, but won't expire solely based on time. Alternatively, a token can be obtained using Basic authentication against the “Me” endpoint as described above. The token itself can be obtained by logging in to the web application, going to "My Preferences", and clicking on the "Authentication Token" tab. H 'Authorization: Basic ENCODED_STRING' \Ĭlients can use a custom per-user authentication token by sending an Authorization header in the following format: Authorization: Token
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |