> ## 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 Related Data
> Get data for fields related to a table record.
While this method /can/ be used to fetch plain fields, that is not the intended usage and it does not replace the Entity.Get methods available for that purpose. Nor does it replace the generic DotSyntax/Dynamic archive provider.
NsApiSlow threshold: 5000 ms.
## OpenAPI
````yaml /openapi/agent/openapi-v3-ArchiveAgent.json post /api/v1/Agents/Archive/GetRelatedData
openapi: 3.0.0
info:
version: v1-Agents
title: SuperOffice Agent API v1
description: SuperOffice Agent API - ArchiveAgent
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/Archive/GetRelatedData:
post:
tags:
- Archive_Agent
summary: Get Related Data
description: "Get data for fields related to a table record.\n\nWhile this method /can/ be used to fetch plain fields, that is not the intended usage and it does not replace the Entity.Get methods available for that purpose. Nor does it replace the generic DotSyntax/Dynamic archive provider.\r\nNsApiSlow threshold: 5000 ms."
operationId: v1ArchiveAgent_GetRelatedData
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.ArchiveCarriers.GetRelatedDataRequest
text/json:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.GetRelatedDataRequest
application/xml:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.GetRelatedDataRequest
text/xml:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.GetRelatedDataRequest
application/x-www-form-urlencoded:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.GetRelatedDataRequest
application/json-patch+json:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.GetRelatedDataRequest
application/merge-patch+json:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.GetRelatedDataRequest
description: Table, RecordId, Fields
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SuperOffice.CRM.Services.RelatedData'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/SuperOffice.CRM.Services.RelatedData'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/SuperOffice.CRM.Services.RelatedData'
text/xml:
schema:
type: array
items:
$ref: '#/components/schemas/SuperOffice.CRM.Services.RelatedData'
application/json-patch+json:
schema:
type: array
items:
$ref: '#/components/schemas/SuperOffice.CRM.Services.RelatedData'
application/merge-patch+json:
schema:
type: array
items:
$ref: '#/components/schemas/SuperOffice.CRM.Services.RelatedData'
security:
- SuperOffice_Password: []
SuperId_Authentication: []
components:
schemas:
SuperOffice.WebApi.v1.Carriers.ArchiveCarriers.GetRelatedDataRequest:
description: >-
GetRelatedData: Get data for fields related to a table record. While
this method /can/ be used to fetch plain fields, that is not the
intended usage and it does not replace the Entity.Get methods available
for that purpose. Nor does it replace the generic DotSyntax/Dynamic
archive provider.
type: object
properties:
Table:
type: string
RecordId:
format: int32
type: integer
Fields:
type: array
items:
type: string
SuperOffice.CRM.Services.RelatedData:
description: "Display data items for one or more related-table fields, specified using a root entity and dot-syntax\r\n\r\nCarrier object for RelatedData.\r\nServices for the RelatedData Carrier is available from the Archive Agent."
type: object
properties:
Field:
description: >-
The name of a 'related field'. This must be a valid column name in
the DotSyntax/Dynamic system, implicitly starting with the given
root table
type: string
FieldValue:
$ref: '#/components/schemas/SuperOffice.CRM.ArchiveLists.ArchiveColumnData'
SuperOffice.CRM.ArchiveLists.ArchiveColumnData:
description: "Data carrier class for an item (cell) in an archive. This class contains properties and\r\nmembers for three distinct values: The (visible) display value; the tooltip hint, and the link hint."
type: object
properties:
DisplayValue:
description: "The visible display value for an archive cell. It is always a string, and other data types\r\nare converted to string according to the invariant culture. Further conversion to the local\r\nculture is the responsibility of the client."
type: string
TooltipHint:
description: "The tooltip hint is either a text to be shown (after resource tag substitution), or a tooltip\r\nkey to be given to the tooltip provider system in order to asynchronoously retrieve the actual\r\ntooltip."
type: string
LinkHint:
description: "The link hint consists of information to construct an actual link; additional information (such\r\nas a view context) must be provided by the client, who is also responsible for building the link.\r\nThe content of the link will generally be one or more ids, such as contact_id=123."
type: string
````
## Related topics
- [SuperOffice.WebApi.Data.Archive GetRelatedDataRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Archive_GetRelatedDataRequest.md)
- [SuperOffice.WebApi.Agents.ArchiveAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ArchiveAgent.md)
- [SuperOffice.WebApi.Agents.IArchiveAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IArchiveAgent.md)
- [Get Related Data2](/en/api/reference/restful/agent/archive_agent/get-related-data2.md)
- [SuperOffice.WebApi.Data.Archive GetRelatedData2Request](/en/api/reference/webapi/SuperOffice.WebApi.Data.Archive_GetRelatedData2Request.md)
- [SuperOffice.WebApi.Data.RelatedData](/en/api/reference/webapi/SuperOffice.WebApi.Data.RelatedData.md)