> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Preference Description Line

> Gets a PreferenceDescriptionLine object.

Calls the Preference agent service GetPreferenceDescriptionLine.
NsApiSlow threshold: 1000 ms.



## OpenAPI

````yaml /openapi/rest/openapi-v3-PreferenceDescriptionLine.json get /api/v1/PreferenceDescriptionLine/{id}
openapi: 3.0.0
info:
  version: v1-REST
  title: SuperOffice REST API v1
  description: SuperOffice REST API - PreferenceDescriptionLine
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/PreferenceDescriptionLine/{id}:
    get:
      tags:
        - PreferenceDescriptionLine
      summary: Get Preference Description Line
      description: "Gets a PreferenceDescriptionLine object.\n\nCalls the Preference agent service GetPreferenceDescriptionLine.\r\nNsApiSlow threshold: 1000 ms."
      operationId: v1PreferenceDescriptionLine_GetPreferenceDescriptionLine
      parameters:
        - name: id
          in: path
          description: The id of the PreferenceDescriptionLine to return.
          required: true
          schema:
            type: integer
            format: int32
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category" Default = show all fields.
          required: false
          schema:
            type: string
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: PreferenceDescriptionLine found.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.WebApi.v1.Carriers.PreferenceCarriers.PreferenceDescriptionLineWithLinks
            text/json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.WebApi.v1.Carriers.PreferenceCarriers.PreferenceDescriptionLineWithLinks
            application/xml:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.WebApi.v1.Carriers.PreferenceCarriers.PreferenceDescriptionLineWithLinks
            text/xml:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.WebApi.v1.Carriers.PreferenceCarriers.PreferenceDescriptionLineWithLinks
            application/json-patch+json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.WebApi.v1.Carriers.PreferenceCarriers.PreferenceDescriptionLineWithLinks
            application/merge-patch+json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.WebApi.v1.Carriers.PreferenceCarriers.PreferenceDescriptionLineWithLinks
        '404':
          description: Not Found.
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.PreferenceCarriers.PreferenceDescriptionLineWithLinks:
      description: "Preference description line, contains information about a single item in a preference description list.\r\n<para />\r\nPreferenceDescriptionLine entity with API _Links added."
      type: object
      properties:
        PrefDescLineId:
          format: int32
          description: Primary key
          type: integer
        PrefDescId:
          format: int32
          description: Preference description (parent)
          type: integer
        PrefValue:
          description: Possible value
          type: string
        PrefShowValue:
          description: Descriptive value, multilang-parsed, to put in list
          type: string
        Description:
          description: Description of preference value, multi-language parsed
          type: string
        IsBuiltin:
          description: 1 = This row populated and maintained by SuperOffice
          type: boolean
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
        _Links:
          type: object
          additionalProperties:
            type: string
    SuperOffice.CRM.Security.TableRight:
      description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string
    SuperOffice.CRM.Security.FieldProperty:
      description: >-
        Class holding properties like field length, field type about a field in
        the carrier.
      type: object
      properties:
        FieldRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
        FieldType:
          type: string
        FieldLength:
          format: int32
          description: ''
          type: integer
    SuperOffice.CRM.Security.FieldRight:
      description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string

````

## Related topics

- [Get Preference Description Line](/en/api/reference/restful/agent/preference_agent/get-preference-description-line.md)
- [Get Preference Description Line From Id And Value](/en/api/reference/restful/agent/preference_agent/get-preference-description-line-from-id-and-value.md)
- [Get Preference Description Lines By Pref Desc Id](/en/api/reference/restful/agent/preference_agent/get-preference-description-lines-by-pref-desc-id.md)
- [NSPreferenceAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSPreferenceAgent.md)
- [SuperOffice.WebApi.Data.Preference GetPreferenceDescriptionLineFromIdAndValueRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Preference_GetPreferenceDescriptionLineFromIdAndValueRequest.md)
- [SuperOffice.WebApi.Data.Preference GetPreferenceDescriptionLinesByPrefDescIdRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Preference_GetPreferenceDescriptionLinesByPrefDescIdRequest.md)
