List Link Types Custom

GET

Lists custom link types.

Query parameters

cursorstringOptionalformat: "text"

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

deprecatedbooleanOptional

Whether only deprecated link types should be filtered.

limitintegerOptional

The maximum number of items.

modeenumOptional

The iteration mode to use, otherwise if not set, then “after” is used.

Allowed values: afterbefore
namelist of stringsOptional

The list of link type names.

sort_bylist of stringsOptional

The list of fields to sort the items by and how to sort them.

source_types.link_descriptors.is_custom_leaf_typebooleanOptional

True when the descriptor describes a custom leaf type.

source_types.link_descriptors.leaf_onlybooleanOptional

Set to true when only the specified leaf type (no subtypes) is allowed as a link target.

source_types.link_descriptors.leaf_typestringOptionalformat: "text"

Leaf type of the target objects.

source_types.link_descriptors.subtypestringOptionalformat: "text"

Specific subtype of the target objects.

target_types.link_descriptors.is_custom_leaf_typebooleanOptional

True when the descriptor describes a custom leaf type.

target_types.link_descriptors.leaf_onlybooleanOptional

Set to true when only the specified leaf type (no subtypes) is allowed as a link target.

target_types.link_descriptors.leaf_typestringOptionalformat: "text"

Leaf type of the target objects.

target_types.link_descriptors.subtypestringOptionalformat: "text"

Specific subtype of the target objects.

Response

Success.

resultlist of objects

The custom link types.

next_cursorstringOptionalformat: "text"

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptionalformat: "text"

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

List Link Types Custom (POST)
Built with