Categories

List all categories

This endpoint allows you to list all categories.

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

get/categories/all

Request

  • Base URL: https://api.infraspeak.com/v3
  • URL: https://api.infraspeak.com/v3/categories/all
  • 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.

filteredByTechnicalSkillsboolean

When true, returns only categories assignable to technical skills along with their ancestors.

s_is_realboolean

Filter by whether the category is real.

s_namestring

Filter by category name.

s_name_likestring

Filter by category name (partial match).

s_typestring

Filter by category type.

s_codestring

Filter by category code (exact match).

s_code_likestring

Filter by category code (partial match).

s_code_instring[]

Filter by multiple category codes.

s_full_codestring

Filter by full code (exact match).

s_full_code_likestring

Filter by full code (partial match).

s_full_code_instring[]

Filter by multiple category full codes.

s_category_idinteger

Filter by category id.

s_category_id_instring

Filter by multiple category ids, comma-separated.

s_parent_idinteger

Filter by parent category id.

s_parent_id_ininteger[]

Filter by multiple parent category ids.

s_problems-problem_idinteger

Filter by associated problem id.

date_min_updated_atstring date-time

Filter categories updated at or after this date.

date_max_updated_atstring date-time

Filter categories updated at or before this date.

sc_min_idinteger

Filter categories with id greater than or equal to this value.

sc_searchstring

Search categories by name or full code.

sc_type_equipmentboolean

Filter to only return equipment type categories.

Response

OK

Changes

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