Get Custom Object Linkable Objects

GET /rest/v1/customobjects/schema/linkableObjects.json

Returns a list of linkable custom objects and their fields.

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

Responses

200 OK ResponseOfObjectLinkableObject

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 ObjectLinkableObject required

List of permissible objects to use as custom object link field

Model ObjectLinkableObject

name string required

Link object API name

displayName string required

Link object UI display-name

fields array of ObjectLinkableObjectField required

List of fields available on the link object

Model ObjectLinkableObjectField

name string required

Link field API name

displayName string required

Link field name

dataType string required

Link field data type

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": [
    {
      "name": "Example name",
      "displayName": "Example name",
      "fields": [
        {
          "name": "Example name",
          "displayName": "Example name",
          "dataType": "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.