Скачать или смотреть Understanding the ACC API Project Endpoint: filter[type] Parameter Nuances

Discover why the `filter[type]` parameter in the ACC API behaves differently than `filter[name]` and `filter[jobNumber]` and how to effectively use it in your queries.
---
This video is based on the question https://stackoverflow.com/q/77752837/ asked by the user 'Sean_Page' ( https://stackoverflow.com/u/22290798/ ) and on the answer https://stackoverflow.com/a/77824397/ provided by the user 'carol joseph' ( https://stackoverflow.com/u/11339908/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, comments, revision history etc. For example, the original title of the Question was: ACC API - Project Endpoint - filter[type] does not use Contains search

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Understanding the ACC API Project Endpoint: filter[type] Parameter Nuances

When working with the ACC API, developers often face challenges that may seem confusing at first glance. One such issue arises when using various filter parameters in the Projects GET endpoint. Specifically, users have reported inconsistencies with the filter[type] parameter in contrast to filter[name] and filter[jobNumber].

The Problem

While both filter[name] and filter[jobNumber] allow for partial matches, the filter[type] parameter requires an exact match to return expected results. This raises questions among developers:

Is this a design choice?

Should the filterTextMatch parameter be explicitly called every time we want to search using filter[type], even though "contains" is indicated as the default?

Clarifying the Functionality

Default Parameter Behavior

Partial Matches:

When using the parameters filter[name] and filter[jobNumber], the API is designed to allow partial matches. This involves:

Using the default value of filterTextMatch as contains.

Exact Matches:

On the other hand, the filter[type] parameter is strictly different. It requires:

An exact match to the project type value that is recognized by the Autodesk Platform Services (APS).

Understanding filterTextMatch

The filterTextMatch parameter defines how the API handles the search filtering.

Possible Values:

contains: Returns results even if only a part of the value matches.

startsWith: Only returns results that begin with the specified value.

endsWith: Only returns results that end with the specified value.

equals: Returns results that exactly match the specified value.

In this context:

While filter[name] and filter[jobNumber] automatically interpret filterTextMatch for partial matches, the same does not apply to filter[type]. You will not receive results unless the precise project type is specified.

Design Consideration

The discrepancy between how filter[type] operates compared to the other two parameters is intentional. It upholds the integrity of the data by ensuring that project types are precisely defined, which is essential for maintaining clarity and consistency within the platform.

Conclusion

To summarize:

If you want results from the Projects GET endpoint using filter[type], make sure you supply the exact match.

You are encouraged to set the filterTextMatch value if you decide to work with filter[name] or filter[jobNumber].

Navigating the complexities of the ACC API can be challenging, but understanding the subtle distinctions in filter parameters will significantly improve your experience and the efficiency of your API queries.