General Notes and Limitations

Limitations

The REST API cannot run in a configuration where a proxy server requires Basic Authentication before allowing access to the REST resources.

Time formats

Only the following time formats are supported:

Date: yyyy-MM-dd

Time: HH:mm:ss

DateTime: yyyy-MM-dd HH:mm:ss

Calls using other formats will fail.

Floating number formats

Floating numbers input can contain only numerals (0-9), the minus sign (-), and a period (.) .

For example:
156726.8
1.234
-1.00
100

Calls will fail if floating data contains a comma (,), any alphabetic character, white space, or any punctuation other than a period.

Notes

Micro Focus advises you to use only the resources documented in the ALM REST API Reference. Any resources included in the REST API that are not documented are not intended for public use. Be aware that Micro Focus does not support the use of undocumented resources by customers.

URL encoding

URLs sent by an application must be URL encoded. For example, use %20 instead of a space character. For more information about URL encoding, see W3 Schools: URL encoding

Resend cookies

In any request you send to the server, return all cookies sent by the server in the preceding response using "Set-Cookie". Failing to resend the "LWSSO_COOKIE_KEY" can result in authentication expiration while the user is interacting with the REST API service.

Content-type and Accept headers

When sending data, always send a Content-Type header to specify the type of data being sent from the client to the server.

Do not send a Content-Type header unless content is sent.

Always send an Accept header to specify the format of the data to receive from the server. For ad-hoc queries from a browser, you can use an alt clause instead.

Site configuration parameters

Several site configuration parameters affect REST-based applications. Search for REST in the ALM Administrator guide.

Caching

Some resources are cached using an ETag if REST API HTTP caching is enabled. See the Micro Focus Application Lifecycle Management Administrator Guide for details on enabling caching. The cached resources are:

  • customization/entities
  • customization/relations
  • customization/used-lists
  • customization/users