List related objects

The objects whose relation fields point at this one, which is what a related list is built from.

GET/api/v1/objects/{objectId}/related

認証

AuthorizationOAuth2 アクセストークン · header必須

Authorization-code grant with PKCE. Clients are public and hold no secret. Discovery is published at /.well-known/oauth-authorization-server/api/auth.

スコープ:api.access

パスパラメーター

objectIdstring必須

An object's id

最小長 1 · 最大長 255

レスポンス

200

The objects that point here

CrmRelatedObject の配列

fieldIdstring必須

最小長 1 · 最大長 255

fieldKeystring必須

^[a-z][a-z0-9_]{0,62}$ に一致

objectIdstring必須

最小長 1 · 最大長 255

objectKeystring必須

^[a-z][a-z0-9_]{0,62}$ に一致

objectLabelstring必須

orderBystring | null必須

プロパティを表示

いずれか:

string

string

null

null

400

The request body, query or parameters were refused

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

401

The access token is missing, invalid or revoked

errorstring必須

403

The tenant's module is off, or the token's scope or the member's role does not permit the action

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

404

No such record, or none the caller may read

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

413

The request exceeds the route's body limit

errorstring必須

500

An unexpected failure

errorstring必須

リクエスト

curl -X GET '/api/v1/api/v1/objects/string/related' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("/api/v1/api/v1/objects/string/related", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "/api/v1/api/v1/objects/string/related",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Accept": "application/json"
    },
)

レスポンス

[
  {
    "fieldId": "string",
    "fieldKey": "string",
    "objectId": "string",
    "objectKey": "string",
    "objectLabel": "string",
    "orderBy": "string"
  }
]

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}