---
title: "getLineDefinitions"
url: "https://developer.migros.ch/apis/m-menuplan-api-1/versions/e5598a88-4f00-47ee-a264-df022bb82e77/operations/getLineDefinitions"
---

> Full API specification: https://developer.migros.ch/apis/m-menuplan-api-1/versions/e5598a88-4f00-47ee-a264-df022bb82e77.md

# getLineDefinitions

`GET` `/migros/products/menuplan/v1/{tenant}/{subtenant}/LineDefinitions`

Operation ID: `getLineDefinitions`

Retrieve a list of line definitions.

## Path parameters

- `tenant` (string, required)
- `subtenant` (string, required)

## Query parameters

- `SearchTerm` (string, optional)
- `Name` (string, optional)
- `Identifier` (string, optional)
- `Owner` (integer, int32, optional)
- `Type` (integer, int32, optional)
- `IsActive` (boolean, optional)
- `IsVisibleOnline` (boolean, optional)
- `Usage.Year` (integer, int32, required)
- `Usage.IsoWeek` (integer, int32, required)
- `Usage.Owner` (integer, int32, required)
- `OrderBy` (string, optional)
- `PageNumber` (integer, int32, optional)
- `PageSize` (integer, int32, optional)

## Responses

- `200` - OK
- `400` - Bad Request
- `500` - Internal Server Error

## OpenAPI definition

```yaml
openapi: 3.0.4
info:
  title: M-Menuplan API
  version: "1.0"
servers:
  - url: https://api.migros.ch/
paths:
  /migros/products/menuplan/v1/{tenant}/{subtenant}/LineDefinitions:
    get:
      tags:
        - MasterData
      description: Retrieve a list of line definitions.
      operationId: getLineDefinitions
      parameters:
        - name: SearchTerm
          in: query
          schema:
            type: string
        - name: Name
          in: query
          schema:
            type: string
        - name: Identifier
          in: query
          schema:
            type: string
        - name: Owner
          in: query
          schema:
            $ref: "#/components/schemas/Migros.MenuPlan.Infrastructure.Enums.Owner"
        - name: Type
          in: query
          schema:
            $ref: "#/components/schemas/Migros.MenuPlan.Infrastructure.Enums.PlanningType"
        - name: IsActive
          in: query
          schema:
            type: boolean
        - name: IsVisibleOnline
          in: query
          schema:
            type: boolean
        - name: Usage.Year
          in: query
          required: true
          schema:
            type: integer
            format: int32
        - name: Usage.IsoWeek
          in: query
          required: true
          schema:
            type: integer
            format: int32
        - name: Usage.Owner
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/Migros.MenuPlan.Infrastructure.Enums.Owner"
        - name: OrderBy
          in: query
          schema:
            type: string
        - name: PageNumber
          in: query
          schema:
            type: integer
            format: int32
        - name: PageSize
          in: query
          schema:
            type: integer
            format: int32
        - name: tenant
          in: path
          required: true
          schema:
            type: string
        - name: subtenant
          in: path
          required: true
          schema:
            type: string
      responses:
        "200":
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Migros.MenuPlan.Service.Queries.ViewModels.LineDefi\
                    nitionView"
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Migros.MenuPlan.Service.Queries.ViewModels.LineDefi\
                    nitionView"
            text/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Migros.MenuPlan.Service.Queries.ViewModels.LineDefi\
                    nitionView"
        "400":
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
            application/json:
              schema:
                $ref: "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
            text/json:
              schema:
                $ref: "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
        "500":
          description: Internal Server Error
      security:
        - apiKeyAuth: []
security:
  - apiKeyAuth: []
components:
  schemas:
    Migros.MenuPlan.Infrastructure.Enums.Owner:
      enum:
        - 1
        - 2
      type: integer
      format: int32
    Migros.MenuPlan.Infrastructure.Enums.PlanningType:
      enum:
        - 1
        - 2
      type: integer
      format: int32
    Migros.MenuPlan.Service.Queries.ViewModels.LineDefinitionView:
      required:
        - id
        - identifier
        - isActive
        - isVisibleOnline
        - nameTranslations
        - owner
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        identifier:
          type: string
          nullable: true
        type:
          $ref: "#/components/schemas/Migros.MenuPlan.Infrastructure.Enums.PlanningType"
        owner:
          $ref: "#/components/schemas/Migros.MenuPlan.Infrastructure.Enums.Owner"
        nameTranslations:
          type: object
          additionalProperties:
            type: string
          nullable: true
        isActive:
          type: boolean
        isVisibleOnline:
          type: boolean
      additionalProperties: false
    Microsoft.AspNetCore.Mvc.ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
      additionalProperties: {}
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      name: api-key
      in: header
```