List an object's records

A page of records. Four combinations are refused with 400 and cannot be expressed in the parameter list: via requires relatedTo; orderBy cannot be combined with view; cursor requires one of them; and after cannot be combined with either, so page an ordered query with cursor. A cursor positions rows only within the ordering that produced it.

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

認証

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

クエリパラメーター

afterstring

最小長 1 · 最大長 255

cursorstring

最小長 1 · 最大長 1024

dirstring

デフォルト: "desc"

許可される値:ascdesc

limitinteger

最小 1 · 最大 100 · デフォルト: 50

orderBystring

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

relatedTostring

最小長 1 · 最大長 255

viastring

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

viewstring

最小長 1 · 最大長 2048

レスポンス

200

A page of records

itemsCrmRecord[]必須

プロパティを表示

CrmRecord の配列

archivedAtstring<date-time> | null必須

プロパティを表示

いずれか:

string<date-time>

string<date-time>

null

null

createdAtstring<date-time>必須

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ に一致

idstring必須

最小長 1 · 最大長 255

namestring必須

objectIdstring必須

最小長 1 · 最大長 255

revisioninteger必須

最小 1 · 最大 2147483647

updatedAtstring<date-time>必須

valuesobject必須

relationsobject必須

nextCursorstring | null必須

totalinteger | null必須

プロパティを表示

いずれか:

integer

integer

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/records' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Accept: application/json'

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

import requests

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

レスポンス

{
  "items": [
    {
      "archivedAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "name": "string",
      "objectId": "string",
      "revision": 1,
      "updatedAt": "2019-08-24T14:15:22Z",
      "values": {
        "property1": "string",
        "property2": "string"
      },
      "relations": {
        "property1": [
          {
            "archived": true,
            "id": "string",
            "name": "string"
          }
        ],
        "property2": [
          {
            "archived": true,
            "id": "string",
            "name": "string"
          }
        ]
      }
    }
  ],
  "nextCursor": "string",
  "total": -9007199254740991
}

{
  "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"
}