Retrieve all entity definitions

Request

Lists all entity definitions.

Security

OAuth2.0

Query

skipinteger, (int32)

Number of definitions to skip before retrieving results, for example, 1.

takeinteger, (int32)

Number of definitions to retrieve, for example, 10. The maximum is 100.

filterstring

Additional filters to apply when retrieving definitions. Use PropertyName==value for property-based filtering (for example, IsSystemOwned==true), or a free-text value to search in definition names and labels (for example, asset).

definitionsToLoadstringdeprecated

(Deprecated) Definition names to include in the retrieved definitions. Use definitionsToLoadByName instead.

definitionsToLoadByNamestring

Definition names to include in the retrieved definitions, for example, M.Asset, M.Project.Task.

definitionsToLoadByIdstring

Definition IDs to include in the retrieved definitions, for example, 10, 20.

viewModestring(ViewMode)

The level of detail to include in the returned entity definitions. Use Basic or Extended.

Enum:"Basic""Extended"

loadPermissionsboolean

Whether to include all permissions the user has on the entity definition, for example, true or false.

Default:false

includeConditionalMembersboolean

Whether to include conditional members in the result, for example, true or false.

Default:false

excludeTaxonomyDefinitionsboolean

Whether to exclude taxonomy definitions from the result, for example, true or false.

Default:false

excludeSystemOwnedDefinitionsboolean

Whether to exclude system-owned definitions from the result, for example, true or false.

Default:false

excludeLightDefinitionsstring(ExcludeLightDefinition)

Whether to exclude light entity definitions from the result, for example, true or false. Light entity definitions contain only basic information.

Enum:"True""False""UserSecurity"

curl -i -X GET \
  'https://your-server/api/entitydefinitions?skip=0&take=0&filter=string&definitionsToLoad=string&definitionsToLoadByName=string&definitionsToLoadById=string&viewMode=Basic&loadPermissions=false&includeConditionalMembers=false&excludeTaxonomyDefinitions=false&excludeSystemOwnedDefinitions=false&excludeLightDefinitions=True' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json

selfobject(Link)

Represents a link to a resource.

Response

{
  "self": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  }
}