> ## 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 Device Keys On Device Identifier Table

> Returns all ForeignKeys that belong to a device with a given deviceIdentifier and table name.

NsApiSlow threshold: 5000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-ForeignSystemAgent.json post /api/v1/Agents/ForeignSystem/GetDeviceKeysOnDeviceIdentifierTable
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - ForeignSystemAgent
  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/ForeignSystem/GetDeviceKeysOnDeviceIdentifierTable:
    post:
      tags:
        - ForeignSystem_Agent
      summary: Get Device Keys On Device Identifier Table
      description: >-
        Returns all ForeignKeys that belong to a device with a given
        deviceIdentifier and table name.


        NsApiSlow threshold: 5000 ms.
      operationId: v1ForeignSystemAgent_GetDeviceKeysOnDeviceIdentifierTable
      parameters:
        - 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
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ForeignSystemCarriers.GetDeviceKeysOnDeviceIdentifierTableRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ForeignSystemCarriers.GetDeviceKeysOnDeviceIdentifierTableRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ForeignSystemCarriers.GetDeviceKeysOnDeviceIdentifierTableRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ForeignSystemCarriers.GetDeviceKeysOnDeviceIdentifierTableRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ForeignSystemCarriers.GetDeviceKeysOnDeviceIdentifierTableRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ForeignSystemCarriers.GetDeviceKeysOnDeviceIdentifierTableRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ForeignSystemCarriers.GetDeviceKeysOnDeviceIdentifierTableRequest
        description: ApplicationName, DeviceName, DeviceIdentifier, TableName
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.ForeignKey'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.ForeignKey'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.ForeignKey'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.ForeignKey'
            application/json-patch+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.ForeignKey'
            application/merge-patch+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.ForeignKey'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.ForeignSystemCarriers.GetDeviceKeysOnDeviceIdentifierTableRequest:
      description: >-
        GetDeviceKeysOnDeviceIdentifierTable: Returns all ForeignKeys that
        belong to a device with a given deviceIdentifier and table name.
      type: object
      properties:
        ApplicationName:
          type: string
        DeviceName:
          type: string
        DeviceIdentifier:
          type: string
        TableName:
          type: string
    SuperOffice.CRM.Services.ForeignKey:
      description: "Carrier object for ForeignKey.\r\nServices for the ForeignKey Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IForeignSystemAgent\">ForeignSystem Agent</see>."
      type: object
      properties:
        Key:
          description: Subkey (optional)
          type: string
        Value:
          description: Key value
          type: string
        RecordId:
          format: int32
          description: Record in the referenced table
          type: integer
        CreatedDate:
          format: date-time
          description: Registered when  in UTC.
          type: string
        UpdatedDate:
          format: date-time
          description: Last updated when  in UTC.
          type: string
        UpdatedBy:
          description: Name of the person that last updated the foreign key
          type: string
        CreatedBy:
          description: Name of the person that created the foreign key
          type: string
        TableName:
          description: >-
            Table name, transformed to and from numeric table id by the service
            layer
          type: string
        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

- [Get Device Keys On Device Identifier Table Record Id](/en/api/reference/restful/agent/foreignsystem_agent/get-device-keys-on-device-identifier-table-record-id.md)
- [SuperOffice.WebApi.Data.ForeignSystem GetDeviceKeysOnDeviceIdentifierTableRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.ForeignSystem_GetDeviceKeysOnDeviceIdentifierTableRequest.md)
- [SuperOffice.WebApi.Data.ForeignSystem GetDeviceKeysOnDeviceIdentifierTableRecordIdRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.ForeignSystem_GetDeviceKeysOnDeviceIdentifierTableRecordIdRequest.md)
- [NSForeignSystemAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSForeignSystemAgent.md)
- [SuperOffice.WebApi.Agents.IForeignSystemAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IForeignSystemAgent.md)
- [Get Device Keys On Device Identifier](/en/api/reference/restful/agent/foreignsystem_agent/get-device-keys-on-device-identifier.md)
