> ## Documentation Index > Fetch the complete documentation index at: https://docs.yume.cloud/llms.txt > Use this file to discover all available pages before exploring further. # Get resources ## OpenAPI ````yaml /openapi/metrics.json get /v1/crm/metrics/workshops/resources/ openapi: 3.0.3 info: title: Yume API — Аналитика version: 1.0.0 description: Системные метрики, аналитика и отчётность. servers: - url: https://api.yume.cloud description: Production - url: https://api.stage.yume.cloud description: Stage security: [] paths: /v1/crm/metrics/workshops/resources/: get: tags: - workshops summary: Get resources operationId: workshops_resources_list parameters: - in: query name: client schema: type: integer - in: query name: created_at__date__gte schema: type: string format: date - in: query name: created_at__date__lte schema: type: string format: date - in: query name: created_by schema: type: integer - in: query name: inventory schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: pageSize required: false in: query description: Number of results to return per page. schema: type: integer - name: search required: false in: query description: A search term. schema: type: string - in: query name: status schema: type: integer enum: - 0 - 1 - 2 - 3 description: |- * `0` - Новый * `1` - В работе * `2` - Завершено * `3` - Архив - in: query name: type schema: type: integer enum: - 0 - 1 description: |- * `0` - Внутренняя * `1` - Внешняя - in: query name: worker schema: type: integer - $ref: '#/components/parameters/TenantId' responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedMetricsWorkshopResourcesList' description: '' security: - jwtAuth: [] components: parameters: TenantId: name: X-Tenant-Id in: header required: false schema: type: integer description: >- Компания, в контексте которой выполняется запрос — её id из `GET /v1/tenant/`. Пользователь должен состоять в этой компании: чужой id доступа к данным не даёт. Без заголовка компания определяется по домену запроса. schemas: PaginatedMetricsWorkshopResourcesList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/MetricsWorkshopResources' MetricsWorkshopResources: type: object properties: id: type: integer readOnly: true inventory: allOf: - $ref: '#/components/schemas/BaseInventory' readOnly: true inventory_group: allOf: - $ref: '#/components/schemas/BaseInventoryGroup' readOnly: true inventory_group_count: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ price: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ tarif: type: integer nullable: true resource: allOf: - $ref: '#/components/schemas/Resource' readOnly: true nullable: true extra: {} required: - id - inventory - inventory_group - resource BaseInventory: type: object properties: id: type: integer readOnly: true group: type: integer nullable: true title: Группа инвентаря name: type: string title: Название maxLength: 255 unique_id: type: string nullable: true title: Артикул maxLength: 255 category: type: integer nullable: true title: Категория image: type: string format: uri nullable: true title: Изображение extra: title: Доп. данные subleases: type: array items: $ref: '#/components/schemas/InventorySublease' readOnly: true state: type: integer nullable: true title: Состояние disabled: nullable: true oneOf: - $ref: '#/components/schemas/DisabledEnum' - $ref: '#/components/schemas/NullEnum' rental_point: type: integer nullable: true title: Точка проката required: - id - name - subleases BaseInventoryGroup: type: object properties: id: type: integer readOnly: true name: type: string nullable: true title: Название maxLength: 512 created_at: type: string format: date-time readOnly: true title: Создан updated_at: type: string format: date-time readOnly: true title: Обновлен category: type: integer nullable: true title: Категория unit_price: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ title: Цена за единицу unit_count: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ title: Количество единиц unit_type: allOf: - $ref: '#/components/schemas/UnitTypeEnum' title: Единица измерения unit_sum: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ title: Итого за единицы image: type: string format: uri nullable: true title: Изображение unique_id: type: string nullable: true title: Артикул maxLength: 255 barcode: type: string nullable: true title: Штрихкод maxLength: 255 extra: title: Доп. данные filters: type: array items: type: string maxLength: 32 nullable: true title: Фильтры points: type: array items: type: integer maximum: 2147483647 minimum: -2147483648 title: Баллы published: type: boolean title: Опубликовано type: allOf: - $ref: '#/components/schemas/BaseInventoryGroupTypeEnum' title: Тип minimum: 0 maximum: 32767 price: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ lifetime: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true title: Срок службы, дней deleted: type: boolean readOnly: true required: - created_at - deleted - id - updated_at Resource: type: object properties: id: type: integer readOnly: true name: type: string maxLength: 255 type: allOf: - $ref: '#/components/schemas/ResourceTypeEnum' minimum: -32768 maximum: 32767 price: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ count: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ count_left: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ required: - id - name InventorySublease: type: object properties: id: type: integer readOnly: true inventory: type: integer title: Инвентарь user: type: integer title: Владелец субаренды percent: type: string format: decimal pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ title: Процент субаренды start_at: type: string format: date-time nullable: true title: Начало периода end_at: type: string format: date-time nullable: true title: Конец периода is_current: type: boolean readOnly: true created_at: type: string format: date-time readOnly: true title: Создан required: - created_at - id - inventory - is_current - percent - user DisabledEnum: enum: - 0 - 1 - 2 type: integer description: |- * `0` - удалить * `1` - Архив * `2` - Списано NullEnum: enum: - null UnitTypeEnum: enum: - litre - kg - g - ml - piece - m3 type: string description: |- * `litre` - Литр * `kg` - Килограмм * `g` - Грамм * `ml` - Миллилитр * `piece` - Штука * `m3` - Кубический метр BaseInventoryGroupTypeEnum: enum: - 0 - 1 type: integer description: |- * `0` - Аренда * `1` - Продажа ResourceTypeEnum: enum: - 0 - 1 type: integer description: |- * `0` - Количество * `1` - Сумма securitySchemes: jwtAuth: type: http scheme: bearer bearerFormat: JWT ````