Categories

List 'folder-like' Categories

This endpoint allows you to list main 'folder' categories.

The query parameters described below are to be used with the JQL.

get/categories

Request

  • Base URL: https://api.infraspeak.com/v3
  • URL: https://api.infraspeak.com/v3/categories
  • Auth: HTTP bearer

Query parameters

codestring

Filter results by given property value.

limitinteger

Number of categories per page (defaults to no pagination).

pageinteger

Page number for pagination (defaults to no page).

expandedstring

Comma-separated list of relations to include in the response. Allowed values: characteristics, characteristics.characteristic_catalog, Characteristics, characteristics.characteristicCatalog, categoryMeterings, entity, files, maintenancePolicies, maintenanceProcedures, maintenanceProcedures.categoryMetering, technicalSkills, .

sortstring

Sort results by one or more fields. Allowed fields: full_code, name, is_real.

s_full_codestring

Filter by full code (exact match).

s_full_code_likestring

Filter by full code (partial match).

s_namestring

Filter by category name.

s_name_likestring

Filter by category name (partial match).

s_typestring

Filter by category type.

s_category_idinteger

Filter by category id.

s_codestring

Filter by category code (exact match).

s_code_likestring

Filter by category code (partial match).

s_characteristics-characteristic_idstring

Filter by related characteristics id.

s_characteristics-namestring

Filter by related characteristics name.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.