List all type definitions

GET {{baseUrl}}/type-definitions?category=folder&namespace=minim ut aliqua&expandAll=false&include-total=false&page=61627017&items-per-page=61627017&filter=minim ut aliqua&sortby=minim ut aliqua

List all type definitions

Request Params

KeyDatatypeRequiredDescription
categorystringThe type category
namespacestringNamespace of the type
expandAllbooleanIncludes all the related artifacts (attributes, index-definitions, operations...) in this call.
include-totalbooleanIncludes total count
pagenumberThe page number required
items-per-pagenumberNumber of items per page
filterstringFilter the list of type-definitions. For example, ?filter = system_name like 'cms_%'
sortbystringSort by field/attribute names. Default sort order is ascending and multiple sort condition should be separated by comma.

Pass 'asc/desc' text after the value to change the sort order. e.g., to sort by 'system_name' and 'table_name' attribute in ascending order use ?sortby=system_name asc, table_name asc

Note: Not all attributes support sort. |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"_embedded":{"collection":[{"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"display_name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"description":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"namespace":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"namespace_prefix":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"system_name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"category":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"version":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"etag":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"parent":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"parent_display_name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"raw_script":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"default_locale":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"non_auditable_actions":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"retention_policy_ids":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rel_source_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rel_target_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rel_cardinality":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rel_direction":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rel_integrity_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rel_source_name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rel_target_name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rel_source_display_name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rel_target_display_name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"created_by":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"create_time":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"update_time":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"updated_by":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"active":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"acl_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"_links":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"display_name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"description":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"namespace":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"namespace_prefix":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"system_name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"category":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"version":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"etag":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"parent":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"parent_display_name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"raw_script":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"default_locale":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"non_auditable_actions":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"retention_policy_ids":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rel_source_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rel_target_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rel_cardinality":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rel_direction":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rel_integrity_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rel_source_name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rel_target_name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rel_source_display_name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rel_target_display_name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"created_by":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"create_time":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"update_time":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"updated_by":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"active":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"acl_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"_links":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"_links":{"next":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"previous":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"self":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"first":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"last":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}}