Rename an object

A label reaches every grid heading and the sidebar, so the update carries the revision it was read at and a stale one is refused.

PATCH/api/v1/objects/{objectId}

認証

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

ヘッダーパラメーター

Idempotency-Keystring必須

Replays the first answer for a repeated request

最小長 8 · 最大長 128

リクエストボディ

必須application/json

keystring

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

labelstring必須

最小長 1 · 最大長 120

revisioninteger必須

最小 1 · 最大 2147483647

singularLabelstring | null

プロパティを表示

いずれか:

string

string

null

null

レスポンス

200

The object as it now stands

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

keystring必須

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

kindstring必須

許可される値:standardcustom

labelstring必須

moduleKeystring必須

許可される値:unavailablecoreapicpqreportsdocumentsapprovalscustom_objectsmarketingmcp

revisioninteger必須

最小 1 · 最大 2147483647

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

409

The operation conflicts with the current state

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

413

The request exceeds the route's body limit

errorstring必須

500

An unexpected failure

errorstring必須

リクエスト

curl -X PATCH '/api/v1/api/v1/objects/string' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Idempotency-Key: stringst' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "key": "string",
  "label": "string",
  "revision": 1,
  "singularLabel": "string"
}'

const response = await fetch("/api/v1/api/v1/objects/string", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Idempotency-Key": "stringst",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"key\": \"string\",\n  \"label\": \"string\",\n  \"revision\": 1,\n  \"singularLabel\": \"string\"\n}"
});

import requests

response = requests.patch(
    "/api/v1/api/v1/objects/string",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Idempotency-Key": "stringst",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"key\": \"string\",\n  \"label\": \"string\",\n  \"revision\": 1,\n  \"singularLabel\": \"string\"\n}",
)

レスポンス

{
  "archivedAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "id": "string",
  "key": "string",
  "kind": "standard",
  "label": "string",
  "moduleKey": "unavailable",
  "revision": 1
}

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

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

{
  "error": "string"
}

{
  "error": "string"
}