MRI Software Asset groups API

openapi: 3.2.0
info:
  title: Mri Software Asset groups API
  version: '0.1'
  contact:
    email: support@whosonlocation.com
  description: 'Operations tagged Asset groups across 2 of this provider''s published API definitions: mri-software-onlocation-openapi.json, mri-software-onlocation-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.whosonlocation.com/v1
tags:
- name: Asset groups
  description: 'All asset types are associated with an asset group. An asset group connects asset types that have similar characteristics. Use the API to retrieve a list of all asset groups, add or update, or delete an asset group.


    Learn more about asset groups in the OnLocation Help Center.'
paths:
  /assetgroup:
    get:
      tags:
      - Asset groups
      summary: List asset groups
      description: Returns a list of asset groups.
      operationId: getAssetGroupList
      parameters:
      - name: q
        in: query
        description: Filter by any asset group value.
        required: false
        schema:
          type: string
          format: string
        example: name:desks,class:fixed,description:anydescriptions
      - name: limit
        in: query
        description: Limits the amount of records to return (maxiumum 5000).
        required: false
        schema:
          type: integer
          format: int32
        example: '10'
      responses:
        '200':
          description: List of asset groups
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AssetgroupResponse'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AssetgroupResponse'
        '403':
          description: Access denied to this resource
        '404':
          description: Resource not found
    post:
      tags:
      - Asset groups
      summary: Create an asset group
      description: Creates a new asset group that can be assigned to an asset.
      operationId: createAssetGroup
      requestBody:
        description: Information to use when creating a new asset group record.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetgroupRequest'
      responses:
        '201':
          description: Asset Group created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetgroupResponse'
        '403':
          description: Access denied to this resource
        '500':
          description: Internal server error
    servers:
    - url: https://api.whosonlocation.com/v1
  /assetgroup/{id}:
    get:
      tags:
      - Asset groups
      summary: Retrieve an asset group
      description: Retrieves a single asset group, filtering with the provided ID.
      operationId: getAssetGroup
      parameters:
      - name: id
        in: path
        description: ID of the asset group to retrieve
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetgroupResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/AssetgroupResponse'
        '403':
          description: Access denied to resource
        '404':
          description: Resource not found
        '500':
          description: Internal server error
    put:
      tags:
      - Asset groups
      summary: Update an asset group
      description: Updates the details of an asset group.
      operationId: updateAssetGroup
      parameters:
      - name: id
        in: path
        description: ID of the asset group to update
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        description: Information used to update the asset group record
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetgroupRequest'
      responses:
        '200':
          description: Updated resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetgroupResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/AssetgroupResponse'
        '403':
          description: Access denied to this resource
        '500':
          description: Internal server error
    delete:
      tags:
      - Asset groups
      summary: Delete an asset group
      description: Deletes an asset group using the provided ID.
      operationId: deleteAssetGroup
      parameters:
      - name: id
        in: path
        description: ID of the asset group to delete
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '204':
          description: Asset Group deleted
        '403':
          description: Access denied to resource
        '404':
          description: Resource not found
        '500':
          description: Internal server error
    servers:
    - url: https://api.whosonlocation.com/v1
components:
  schemas:
    AssetgroupRequest:
      title: AssetgroupRequest
      description: Asset Group request body data
      properties:
        name:
          description: Name of asset group
          type: string
          format: string
          example: Laptops Group
        class:
          type: string
          enum:
          - transfer
          - fixed
          example: fixed
        description:
          description: Description of asset group
          type: string
          format: string
          example: This group includes the assets that belong to this location
      type: object
    AssetgroupResponse:
      title: AssetgroupResponse
      description: Asset Group response schema
      properties:
        id:
          type: integer
          format: int32
          example: 90008
        name:
          description: Name of asset group
          type: string
          format: string
          example: Laptops Group
        class:
          type: string
          enum:
          - transfer
          - fixed
          example: fixed
        description:
          description: Description of asset group
          type: string
          format: string
          example: This group includes the assets that belong to this location
      type: object
x-refined-from:
- mri-software-onlocation-openapi.json
- mri-software-onlocation-openapi.yml