GET Relationship Extension Fields

Retrieve a list of extension fields related to a relationship.

Endpoint

Endpoint	`/api/relationships/<entity-id>/extensionfields`
Method	GET

Headers


Header	Argument
Authorization	Bearer token
Accept	application/json or application/xml

Parameters

Table 1. Path parameters
Parameter	Example	Description
`entity-id`	`e14e044e-e847-47e4-a8e8-01f2e6341fbf`	Unique identifier of relationship.

Table 2. Query parameters
Parameter	Data Type	Description
limit	int	Maximum number of items in the response. Maximum: 50.
offset	int	Number of items to skip from the start. Default: 0.
name	string	Extension field name. You can filter by this parameter using these operators: [eq], [contains]

Elements

The following elements are available for the Extension Fields API:


Element	Data Type	Description
success	boolean	Whether the request was successful.
totalCount	integer	Total number of extension fields that match the filter criteria across all pages. Note: Use the limit and offset query parameters to retrieve additional sets of data if totalCount exceeds the page size.
result	array	Current page of evaluation results, with up to 50 extension fields per request (determined by limit and offset).
errors	array	List of error objects. Typically empty when the request is successful.
entityId	string	Unique, permanent GUID that represents the relationship within the system.
relationshipName	string	Name of the relationship, provided by the user during the creation process.
name	string	Name of the extension field.
value	string	Value of the extension field.

Get relationship extension fields

Endpoint

GET /api/relationships/e14e044e-e847-47e4-a8e8-01f2e6341fbf/extensionfields

Example cURL request

curl --location 'https://<your-instance>.risk.coupadev.com/api/relationships/e14e044e-e847-47e4-a8e8-01f2e6341fbf/extensionfields' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••'

Example response

{
    "result": {
        "entityId": "e14e044e-e847-47e4-a8e8-01f2e6341fbf",
        "totalCount": 66,
        "relationshipName": "Relationship_Rest<API&Test2",
        "extensionFields": [
            {
                "name": "aabudf2",
                "value": "False"
            },
            {
                "name": "aabudf3",
                "value": "False"
            },
            {
                "name": "aacudf4",
                "value": ""
            },
            {
                "name": "aacudf5",
                "value": ""
            },
            {
                "name": "aaudf1",
                "value": ""
            },
            {
                "name": "abcd1234___",
                "value": ""
            },
            {
                "name": "abcdxyz",
                "value": ""
            },
            {
                "name": "amendmentdescription",
                "value": ""
            },
            {
                "name": "approvalstatus",
                "value": ""
            },
            {
                "name": "autorenewalenabled",
                "value": "False"
            },
            {
                "name": "businessunit",
                "value": ""
            },
            {
                "name": "compliancedetails",
                "value": ""
            },
            {
                "name": "compliancerequired",
                "value": "False"
            },
            {
                "name": "confidentialityrequired",
                "value": "False"
            },
            {
                "name": "contractenddate",
                "value": ""
            },
            {
                "name": "contractowner",
                "value": ""
            },
            {
                "name": "contractstartdate",
                "value": ""
            },
            {
                "name": "contractstatus",
                "value": ""
            },
            {
                "name": "contractvalue",
                "value": ""
            },
            {
                "name": "counterpartyname",
                "value": ""
            },
            {
                "name": "customnotes",
                "value": ""
            },
            {
                "name": "department",
                "value": ""
            },
            {
                "name": "governinglaw",
                "value": ""
            },
            {
                "name": "insuranceexpirydate",
                "value": ""
            },
            {
                "name": "insuranceprovider",
                "value": ""
            },
            {
                "name": "insurancerequired",
                "value": "False"
            },
            {
                "name": "jurisdiction",
                "value": ""
            },
            {
                "name": "lastamendmentdate",
                "value": ""
            },
            {
                "name": "lastreviewdate",
                "value": ""
            },
            {
                "name": "licenseexpirydate",
                "value": ""
            },
            {
                "name": "licenseincluded",
                "value": "False"
            },
            {
                "name": "licensetype",
                "value": ""
            },
            {
                "name": "linkedcontracts",
                "value": ""
            },
            {
                "name": "ndaexpirydate",
                "value": ""
            },
            {
                "name": "ndasigned",
                "value": "False"
            },
            {
                "name": "nextreviewdate",
                "value": ""
            },
            {
                "name": "noticeperioddays",
                "value": ""
            },
            {
                "name": "numberofamendments",
                "value": ""
            },
            {
                "name": "parentcontract",
                "value": ""
            },
            {
                "name": "paymentfrequency",
                "value": ""
            },
            {
                "name": "paymentmethod",
                "value": ""
            },
            {
                "name": "paymentterms",
                "value": ""
            },
            {
                "name": "primarycontact",
                "value": ""
            },
            {
                "name": "primarycontactemail",
                "value": ""
            },
            {
                "name": "primarycontactphone",
                "value": ""
            },
            {
                "name": "rel_udf",
                "value": "test_<&value"
            },
            {
                "name": "relationshiptype",
                "value": ""
            },
            {
                "name": "renewaldate",
                "value": ""
            },
            {
                "name": "renewaloption",
                "value": ""
            },
            {
                "name": "renewalterms",
                "value": ""
            }
        ]
    },
    "errors": [],
    "success": true
}

Coupa Documentation