Developer ToolsFree generatorPDF, Excel, Word exportIFS Cloud

IFS Cloud Projection API URL Builder

IFS Cloud exposes business data through projections that follow OData conventions. Getting the URL and the token call right is the first hurdle for any integration. This builder produces both from a few fields so you can test in a REST client in minutes.

Fill in

IFS Cloud host

Host name only, no https://

Auth realm

The realm segment used in your IAM token URL.

Client ID

Projection name

The projection service name without .svc

Entity set

$select fields

Comma separated, no spaces

$filter

$orderby

$top

Generated code

Download:

1. Request an access token

POST https://mycompany.ifs.cloud/auth/realms/mycompanyprod/protocol/openid-connect/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=my_integration_client&client_secret=<your-secret>

2. Query the projection

GET https://mycompany.ifs.cloud/main/ifsapplications/projection/v1/CustomerOrderHandling.svc/CustomerOrderSet?$select=OrderNo,CustomerNo,State&$filter=State eq 'Planned'&$orderby=OrderNo desc&$top=50
Authorization: Bearer <access_token>
Accept: application/json

3. Read the service metadata

GET https://mycompany.ifs.cloud/main/ifsapplications/projection/v1/CustomerOrderHandling.svc/$metadata
Authorization: Bearer <access_token>
Accept: application/xml

URL encode spaces and quotes in the filter before using it from code (a space becomes %20). Entity set and field names must match the projection metadata for your release. Use the $metadata call to confirm them. The client needs a granted permission set for the projection. Never put client secrets in source control.

Want a governed read-only AI layer on IFS data?

We can walk through how questions map to projection calls with visible queries and role checks.

Optional. The tool and every export work without this. No spam.

How to use the builder

Enter your IFS Cloud host and realm, then the projection and entity set you want to read. Add a select list, a filter and a top value to keep responses small. Copy the generated token request and GET request into your REST client, replace the placeholders for the secret and the token, and run them in order.

Host name without https://
Projection name without the .svc suffix
Start with a small $top while testing
Check $metadata for exact names

The URL structure

Projection requests follow the pattern host, then /main/ifsapplications/projection/v1/, then the projection service name with .svc, then the entity set. Query options such as $select, $filter, $orderby and $top use standard OData syntax. Authentication uses an access token from the IAM realm of your environment, obtained with the client credentials grant for service integrations.

Filtering and paging

String values in filters are wrapped in single quotes, and comparison operators are words such as eq, ne, gt and lt. Combine conditions with and or or. For large result sets, use $top together with the paging links the service returns instead of requesting everything at once. Select only the fields you need, which reduces payload and avoids exposing columns you do not require.

Common mistakes

Frequent problems are using the wrong realm in the token URL, forgetting that the integration client needs a permission set for the projection, and typing entity set names from memory. Another is sending an unencoded filter from code. A 401 usually points to the token or realm, a 403 to missing permissions, and a 404 to a wrong projection or entity set name for your release.

Frequently Asked Questions

Does this work for every IFS Cloud release?

The pattern is common across IFS Cloud, but projection names, entity sets and fields change between releases. Always confirm against the $metadata of your own environment before building on a field name.

Where do I get the client ID and secret?

An IFS administrator creates an integration client in the identity setup of your environment and grants the permission sets it needs. Ask your administrator rather than reusing a person's credentials.

Can I write data with the same URL?

Projections support create and update operations too, but writes need the right permissions and careful validation. This builder covers reads only. Test writes in a non-production environment first.

Is anything sent to Netray?

No. The builder fills text in your browser. Do not paste real secrets into the page. Leave the secret as a placeholder and set it in your REST client.

If you are building IFS integrations or want a read-only AI layer on IFS data, Netray can help design it so the queries are visible and role aware.

Talk to an Expert Explore More Free Tools

Related Tools

MES & Shop Floor

More Developer Tools tools

See all

Back to All Tools