Skip to content

List non-unique indexes for one entity definition.

GET
/api/workspace/admin/entity-definitions/{entityDefinitionId}/indexes
curl --request GET \
--url https://example.com/api/workspace/admin/entity-definitions/example/indexes
  • None
entityDefinitionId
required
string
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

OK

Media typeapplication/json
object
Data
Array<object>
nullable

Non-unique index configured for one entity definition table.

object
Id

Index identifier.

string
nullable
EntityDefinitionId

Entity definition identifier.

string
nullable
EntityDefinitionTableId

Owning table identifier.

string
nullable
Fields

Ordered participating fields.

Array<object>
nullable

Field participating in one definition index.

object
Id

Field identifier.

string
nullable
EntityDefinitionTableId

Owning table identifier.

string
nullable
Key

Internal field key.

string
nullable
DisplayName

User-facing field name.

string
nullable
RowVersion

Concurrency token.

string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Not Found

Media typeapplication/json
object
Data
Array<object>
nullable

Non-unique index configured for one entity definition table.

object
Id

Index identifier.

string
nullable
EntityDefinitionId

Entity definition identifier.

string
nullable
EntityDefinitionTableId

Owning table identifier.

string
nullable
Fields

Ordered participating fields.

Array<object>
nullable

Field participating in one definition index.

object
Id

Field identifier.

string
nullable
EntityDefinitionTableId

Owning table identifier.

string
nullable
Key

Internal field key.

string
nullable
DisplayName

User-facing field name.

string
nullable
RowVersion

Concurrency token.

string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}