GET Relationship UDOs

Retrieve a paginated list of User Defined Objects (UDOs) that are direct children of a relationship.

Endpoint

Endpoint	`/api/relationships/{relationshipId}/udos`
Method	GET
Scope	riskassess.relationship.read

Headers


Header	Argument
Authorization	Bearer token
Accept	application/json or application/xml
X-Correlation-Id	(Optional) Request tracing ID

Parameters

Table 1. Path parameters
Parameter	Description
relationshipId	Relationship entityId (GUID). Must not be an empty GUID.

Table 2. Query parameters
Parameter	Required	Description
limit	No	Maximum number of items to return. Default: 50.
offset	No	Number of items to skip from start. Default: 0.
udoName	No	Filter by UDO type name (case-insensitive). Must include the 'UserDefined.' prefix. Supports [eq] and [contains] operators. Examples: UserDefined.Product (exact match with [eq]), UserDefined.Prod (partial match with [contains]).

Table 3. Filterable fields
API field	Filter	Sort (order_by)
udoName	Yes	No

Elements

The following elements are available in the response:


Element	Data Type	Description
success	boolean	Whether the request was successful.
errors	array	List of error objects. Typically empty when the request is successful.
result	object	Container object containing totalCount and udos array.
totalCount	integer	Total number of UDOs that match the filter criteria across all pages.
udos	array	Array of UDO objects for the current page.
entityId	string (GUID)	Unique identifier for the UDO instance.
parentEntityId	string (GUID)	EntityId of the immediate parent (the relationship for root-level UDOs).
objectName	string	UDO type name (e.g., UserDefined.Product, Models.Comment).
extensionFields	array	Array of extension field objects containing only UDOUnique fields (name and value pairs).
children	array	Array of level-2 child summary objects (entityId, objectName, links only).
links	array	Array of link objects including _self reference to the detail endpoint.

Get relationship UDOs

Endpoint

GET /api/relationships/{relationshipId}/udos

Example cURL request

curl --location 'https://<your-instance>.risk.com/api/relationships/3a2edf76-ca80-46cc-bddd-761ecbbdd658/udos?limit=50&offset=0' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ••••••'

Example cURL request with filter

curl --location 'https://<your-instance>.risk.com/api/relationships/3a2edf76-ca80-46cc-bddd-761ecbbdd658/udos?udoName[eq]=UserDefined.Product' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ••••••'

Example response

{
  "success": true,
  "errors": [],
  "result": {
    "totalCount": 2,
    "udos": [
      {
        "entityId": "guid-1",
        "parentEntityId": "3a2edf76-ca80-46cc-bddd-761ecbbdd658",
        "objectName": "UserDefined.Product",
        "extensionFields": [
          { "name": "SKU", "value": "A1" }
        ],
        "children": [
          {
            "entityId": "guid-3",
            "objectName": "UserDefined.Component",
            "links": [
              { "rel": "_self", "href": "api/relationships/3a2edf76-ca80-46cc-bddd-761ecbbdd658/udos/guid-1/guid-3", "method": "GET" }
            ]
          }
        ],
        "links": [
          { "rel": "_self", "href": "api/relationships/3a2edf76-ca80-46cc-bddd-761ecbbdd658/udos/guid-1", "method": "GET" }
        ]
      },
      {
        "entityId": "guid-4",
        "parentEntityId": "3a2edf76-ca80-46cc-bddd-761ecbbdd658",
        "objectName": "UserDefined.Product",
        "extensionFields": [
          { "name": "SKU", "value": "B7" }
        ],
        "children": [],
        "links": [
          { "rel": "_self", "href": "api/relationships/3a2edf76-ca80-46cc-bddd-761ecbbdd658/udos/guid-4", "method": "GET" }
        ]
      }
    ]
  }
}

Example error response

{
  "success": false,
  "result": null,
  "errors": [
    {
      "message": "Relationship not found",
      "errorCode": "DataNotFound"
    }
  ]
}

Coupa Documentation