API Reference

List Object Types

GET/api/v1/ontologies/{ontologyRid}/objectTypes

Lists the object types for the given Ontology.

Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, at least one result will be present in the response.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:ontologies-read.

Path parameters

ontologyRid

string

The unique Resource Identifier (RID) of the Ontology that contains the object types. To look up your Ontology RID, please use the List ontologies endpoint or check the Ontology Manager.

Query parameters

pageSize

integer

optional

The desired size of the page to be returned. Defaults to 500. See page sizes for details.

pageToken

string

optional

The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and use it to populate the pageToken field of the next request.

Response body

ListObjectTypesResponse

object

Success response.

Hide child attributes

nextPageToken

string

optional

data

list<ObjectType>

optional

The list of object types in the current page.

Show child attributes

ObjectType

object

Represents an object type in the Ontology.

Show child attributes

apiName

string

The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the List object types endpoint or check the Ontology Manager.

displayName

string

optional

The display name of the entity.

status

string (enum)

The release status of the entity.

Enum values: ACTIVE, EXPERIMENTAL, DEPRECATED

description

string

optional

The description of the object type.

visibility

string (enum)

optional

The suggested visibility of the object type.

Enum values: NORMAL, PROMINENT, HIDDEN

primaryKey

list<PropertyApiName>

optional

The primary key of the object. This is a list of properties that can be used to uniquely identify the object.

Show child attributes

PropertyApiName

string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

properties

map<PropertyApiName, Property>

optional

A map of the properties of the object type.

Show child attributes

PropertyApiName

string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

Property

object

Details about some property of an object.

Show child attributes

description

string

optional

displayName

string

optional

The display name of the entity.

baseType

string

A string indicating the type of each data value. Note that these types can be nested, for example an array of structs.

Type	JSON value
Array	`Array<T>`, where `T` is the type of the array elements, e.g. `Array<String>`.
Attachment	`Attachment`
Boolean	`Boolean`
Byte	`Byte`
Date	`LocalDate`
Decimal	`Decimal`
Double	`Double`
Float	`Float`
Integer	`Integer`
Long	`Long`
Marking	`Marking`
OntologyObject	`OntologyObject<T>` where `T` is the API name of the referenced object type.
Short	`Short`
String	`String`
Struct	`Struct<T>` where `T` contains field name and type pairs, e.g. `Struct<{ firstName: String, lastName: string }>`
Timeseries	`TimeSeries<T>` where `T` is either `String` for an enum series or `Double` for a numeric series.
Timestamp	`Timestamp`

rid

string

The unique resource identifier of an object type, useful for interacting with other Foundry APIs.

Examples

Request

Copied!

curl \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/objectTypes"

Response

Copied!

{
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z",
  "data": [
    {
      "apiName": "employee",
      "description": "A full-time or part-time employee of our firm",
      "primaryKey": [
        "employeeId"
      ],
      "properties": {
        "employeeId": {
          "baseType": "Integer"
        },
        "fullName": {
          "baseType": "String"
        },
        "office": {
          "description": "The unique ID of the employee's primary assigned office",
          "baseType": "String"
        },
        "startDate": {
          "description": "The date the employee was hired (most recently, if they were re-hired)",
          "baseType": "Date"
        }
      },
      "rid": "ri.ontology.main.object-type.401ac022-89eb-4591-8b7e-0a912b9efb44"
    },
    {
      "apiName": "office",
      "description": "A physical location (not including rented co-working spaces)",
      "primaryKey": [
        "officeId"
      ],
      "properties": {
        "officeId": {
          "baseType": "String"
        },
        "address": {
          "description": "The office's physical address (not necessarily shipping address)",
          "baseType": "String"
        },
        "capacity": {
          "description": "The maximum seated-at-desk capacity of the office (maximum fire-safe capacity may be higher)",
          "baseType": "Integer"
        }
      },
      "rid": "ri.ontology.main.object-type.9a0e4409-9b50-499f-a637-a3b8334060d9"
    }
  ]
}