Resource: External System Link Field Values ( /api/externalsystemlink/{linkId}/field/{fieldName} )

Allows retrieval the allowable values for a field associated with an external system link.

Methods

GET

Retrieves all options for a field belonging to an external system link.

Required Permissions

Resources/ExternalLinks

Status Codes

These are the expected status codes returned by the service - in addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

Status	Description
200 - OK	Returned if the request was completed successfully.
403 - Forbidden	Returned if you dont not have permission to retrieve field values for this link.
404 - NotFound	Returned if the link does not exist.

Example - Get all options for a field

An example of retrieving all options for a field belonging to an external system link.

Request Headers

Key	Value	Description
Accept	application/json

Request Parameters

Key	Value	Description
{linkId}	DF463CBF-32C9-4295-8B6C-55AAE7B640B9
{fieldName}	Priority

Response Headers

Key	Value	Description
Content-Type	application/json; charset=utf-8

Response Body

{
  "Skip": 0,
  "Top": 25,
  "Total": 3,
  "Items": [
    {
      "Identifier": "1",
      "Text": "High"
    },
    {
      "Identifier": "2",
      "Text": "Medium"
    },
    {
      "Identifier": "3",
      "Text": "Low"
    }
  ]
}

Status Code

200 - OK

Example - Get all options for field by matching a partial name query

An example of retrieving options for a field belonging to an external system link by matching a partial name query.