GET collaboration/contacts/{contactId}/object-references

Returns a list of objects that is connected/related to/referencing the specified contact. This is typically a list of customers and/or suppliers.

Note: Log in to check if your API client have access to run this resource
Version: 15
Success HTTP Status Code: 200
Maximum items from list ($top): 80

Uri parameters

{contactId} Integer Contact identifier

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold is required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$inlinecount String, optional Only usable when the result is a list. Set to "allpages" if you want size of the result list to be returned. Accepted values are: "allpages", "none"
$top String, optional Only usable when the result is a list. Set the number of objects to return in result list. Maximum limit is specific for each resource, but is default 80.
$filter String, optional Only usable when the result is a list. Use to filter the result list, see the Filter and OrderBy page for more information about this.
$orderby String, optional Only usable when the result is a list. Use to order the result list, see Filter and OrderBy page for more information about this.
$select String, optional Use to define the fields to return in the result. Accepts a comma-separated list of Output Field names. See the Expand and Select page for more information about this.
$db String, optional Set the database to use for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "json"
$lang String, optional Use to get localized responses. Supported formats are 3-letter ISO-639-1 [lll], 2-letter ISO-639-2 [ll], or a combination of a two-letter language code and a two-letter country code ISO-639-2 and ISO-3166-1 [ll_CC], [ll-CC]
$useMinimumVersion Integer, optional This can be used to test a new version of a resource when your ApiClient is running an older, deprecated, version of a resource. $useminimumversion can be used to test against a newer version of the resource. See the Deprecated APIs page for more information about this.

See the page about filters and sorting on how to use filter parameters and named filters.

Database String Company code/database the object belongs to.
ObjectId Integer Identifier of the object.
ObjectType String Type of object.

See the page about filters and sorting on how to use sortable parameters

Database String Company code/database the object belongs to
ObjectId Integer Identifier of the object
ObjectType String Type of object

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<ObjectReferences>
2
     <ObjectReference>
3
          <Description
Description

Description of the object reference

>
{String}</Description>
4
          <Object>
5
               <Database
Database

Company code/database the object belongs to

>
{String}</Database>
6
               <ObjectId
ObjectId

Identifier of the object

>
{Integer}</ObjectId>
7
               <ObjectType
ObjectType

Type of object

>
{String}</ObjectType>
8
               <Status
Status

Status of the object

>
{Integer}</Status>
9
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>
{String}</RamBaseKey>
10
               <ObjectLink
ObjectLink

Object that is connected/referencing the contact. Typically a customer or a supplier.

>
{String}</ObjectLink>
11
          </Object>
12
     </ObjectReference>
13
</ObjectReferences>
1
{
2
     "objectReferences": [
3
          {
4
               "description
Description

Description of the object reference

":
"{String}",
5
               "object": {
6
                    "database
Database

Company code/database the object belongs to

":
"{String}",
7
                    "objectId
ObjectId

Identifier of the object

":
"{Integer}",
8
                    "objectType
ObjectType

Type of object

":
"{String}",
9
                    "status
Status

Status of the object

":
"{Integer}",
10
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

":
"{String}",
11
                    "objectLink
ObjectLink

Object that is connected/referencing the contact. Typically a customer or a supplier.

":
"{String}"
12
               }
13
          }
14
     ]
15
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return: