Get Custom Object Dependent Assets

GET /rest/v1/customobjects/schema/{apiName}/dependentAssets.json

Returns a list of dependent assets for a custom object type, including their in-instance location.

Operation ID: getCustomObjectTypeDependentAssetsUsingGET
Permissions: Read-Only Custom Object Type, Read-Write Custom Object Type
Request format: application/json
Returns: ResponseOfObjectDependentAssets

Parameters

Path 1

apiName string required

REST API name for custom object

Responses

200 OK ResponseOfObjectDependentAssets

errors array of Error required

Array of errors that occurred if the request was unsuccessful

Model Error

code string required

Error code of the error. See full list of error codes here

message string required

Message describing the cause of the error

requestId string required

Id of the request made

result array of ObjectDependentAsset required

List of dependent assets for a custom object type

Model ObjectDependentAsset

assetType string required

Type of asset

assetId integer (int32) required

ID of asset

assetName string required

Name of asset

usedFields array of string

List of associated fields

success boolean required

Whether the request succeeded

warnings array of Warning required

Array of warnings given for the operation

Model Warning

code integer (int32) required

Integer code of the warning

message string required

Message describing the warning

Generated example

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "requestId": "123",
  "result": [
    {
      "assetType": "string",
      "assetId": 123,
      "assetName": "Example name",
      "usedFields": [
        "string"
      ]
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 123,
      "message": "string"
    }
  ]
}

Referenced models

Generated from swagger-mapi.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.