topic Re: API endpoint error / not returning expected results. in Developer

API endpoint error / not returning expected results.

Anonymous — Tue, 23 Apr 2024 10:07:15 GMT

Hi,
I am pulling data from Workguru (our project management software) via API. All working ok however I cannot seem to get the data for a custom field.
This is the Swagger page Swagger UI (workguru.io) https://api.workguru.io/swagger/index.html
This one pulls the detail of the correct custom field https://api.workguru.io/api/services/app/CustomField/GetCustomFieldById?id=2199
However I cannot pull the value of that field in any of the projects.
I think this is the correct endpoint but unsure of the requirements for the description. /api/services/app/CustomField/GetCustomFieldValuesByTypeAndId

Any help would be appreciated - thanks

Re: API endpoint error / not returning expected results.

Anonymous — Wed, 24 Apr 2024 06:57:48 GMT

Hi @Anonymous ,

Base on your description, it seems like you're having trouble pulling the value of a custom field in Workguru via API: /api/services/app/CustomField/GetCustomFieldValuesByTypeAndId. To use this endpoint, you'll need to provide two parameters: 'customFieldTypeId' and 'entityId'. 'customFieldTypeId' refers to the ID of the custom field type you're trying to retrieve, you can get it from the returned detail of `/api/services/app/CustomField/GetCustomFieldById` endpoint. As for the `entityId`, you'll need to provide the ID of the project you're trying to retrieve the custom field value for. Once you have both of these parameters, you can make a GET request to the `/api/services/app/CustomField/GetCustomFieldValuesByTypeAndId` endpoint with the appropriate values and it should return the custom field value for that project.

Best Regards

Re: API endpoint error / not returning expected results.

Anonymous — Fri, 03 May 2024 04:45:55 GMT

Great, thanks @Anonymous - appreciate the help.
Custom field ID is 2199 and an example project ID is 414125
I have tried this /api/services/app/CustomField/GetCustomFieldValuesByTypeAndId?customFieldTypeId=2199&entityid=414125 but pulling returns the following error

DataSource.Error: Web.Contents failed to get contents from 'https://api.workguru.io/api/services/app/CustomField/GetCustomFieldValuesByTypeAndId?customFieldTypeId=2199&entityid=414125' (500): Internal Server Error
Details:
DataSourceKind=Web
DataSourcePath=https://api.workguru.io/api/services/app/CustomField/GetCustomFieldValuesByTypeAndId
Url=https://api.workguru.io/api/services/app/CustomField/GetCustomFieldValuesByTypeAndId?customFieldTypeId=2199&entityid=414125