> ## 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 Report Label Layout Entity

> Gets a ReportLabelLayoutEntity object.

NsApiSlow threshold: 5000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-ReportAgent.json post /api/v1/Agents/Report/GetReportLabelLayoutEntity
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - ReportAgent
  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/Agents/Report/GetReportLabelLayoutEntity:
    post:
      tags:
        - Report_Agent
      summary: Get Report Label Layout Entity
      description: |-
        Gets a ReportLabelLayoutEntity object.

        NsApiSlow threshold: 5000 ms.
      operationId: v1ReportAgent_GetReportLabelLayoutEntity
      parameters:
        - name: reportLabelLayoutEntityId
          in: query
          description: The identifier of the ReportLabelLayoutEntity object
          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: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.ReportLabelLayoutEntity
            text/json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.ReportLabelLayoutEntity
            application/xml:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.ReportLabelLayoutEntity
            text/xml:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.ReportLabelLayoutEntity
            application/json-patch+json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.ReportLabelLayoutEntity
            application/merge-patch+json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.ReportLabelLayoutEntity
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.CRM.Services.ReportLabelLayoutEntity:
      description: "Carrier object for ReportLabelLayoutEntity.\r\nServices for the ReportLabelLayoutEntity Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IReportAgent\">Report Agent</see>."
      type: object
      properties:
        ReportLabelLayoutId:
          format: int32
          description: Primary key
          type: integer
        Name:
          description: Name of the label layout
          type: string
        Description:
          description: Description
          type: string
        Orientation:
          description: 'Paper orientation: 1=portrait, 2=landscape'
          enum:
            - None
            - Portrait
            - Landscape
          type: string
        PaperWidth:
          format: int32
          description: Paper width in twips
          type: integer
        PaperHeight:
          format: int32
          description: Paper height in twips
          type: integer
        LeftMargin:
          format: int32
          description: Left margin in twips
          type: integer
        RightMargin:
          format: int32
          description: Right margin in twips
          type: integer
        TopMargin:
          format: int32
          description: Top margin in twips
          type: integer
        BottomMargin:
          format: int32
          description: Bottom margin in twips
          type: integer
        CountColumns:
          format: int32
          description: Number og columns
          type: integer
        CountRows:
          format: int32
          description: Number of rows
          type: integer
        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'
    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

- [NSReportAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSReportAgent.md)
- [SuperOffice.WebApi.Data.ReportLabelLayoutEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.ReportLabelLayoutEntity.md)
- [SuperOffice.WebApi.Agents.ReportAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ReportAgent.md)
- [SuperOffice.WebApi.Agents.IReportAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IReportAgent.md)
- [NSReportLabelLayoutEntity](/en/automation/crmscript/reference/CRMScript.NetServer.NSReportLabelLayoutEntity.md)
- [ReportLabelLayout](/en/api/archive-providers/reference/reportlabellayout.md)
