Published OData Attribute

Last modified: October 30, 2026

Introduction

The Edit published attribute dialog allows you to edit the properties of an attribute published in an OData/GraphQL service.

Edit published attribute dialog box.

General

Exposed Name

The exposed name is the name of the attribute as it appears to clients of the service. This cannot be the same as the exposed name of the entity.

Can Be Empty

Select this box if there is a possibility for this attribute the have an empty value. One way to make sure no empty values are created in the database is to add a required validation rule.

For attributes that are part of the key of the entity, this box must be unselected.

Entity

The entity that this attribute is a part of.

Attribute

The attribute that is being published. This value cannot be changed; to publish a different attribute, use the Add button in the list of published attributes.

Type

The type of the attribute.

Exposed As

This field is shown in the following cases:

  • The type is an enumeration that was previously exposed as a string (only for OData v4). Change the value to Enumeration to publish the enumeration. This informs clients of the possible values of this attribute.
  • The type is a string (only for OData v4). Change the value to GUID to publish the string attribute as a GUID. For more information, see the Exposing a String Attribute as a GUID section below.

Exposing a String Attribute as a GUID

You can expose a string attribute as a GUID in Studio Pro 10.12 and above. The following applies:

  • The attribute must be a string with unlimited length or a maximum length of at least 36 characters, and store GUIDs in a format such as 1b4e28ba-2fa1-11d2-883f-0016d3cca427.
  • If the value stored at runtime cannot be parsed as a GUID, the runtime throws an error.
  • Clients can specify GUIDs in uppercase or lowercase letters. The runtime always returns GUIDs in lowercase letters.
  • If a POST or PUT request attempts to set a value that is not a GUID, the runtime returns a 422 status code.

Capabilities

Select Sortable to allow clients to sort results based on this attribute.

Select Filter to allow clients to filter results based on this attribute.

Note that these capabilities are not shown for attributes of entities without the Readable capability.

Public Documentation

In the Public documentation tab, you can write a summary and description intended for people using the service.