Create an approval definition

A definition names the stages a record passes through and who approves each one.

POST/api/v1/approval-definitions

認証

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

ヘッダーパラメーター

Idempotency-Keystring必須

Replays the first answer for a repeated request

最小長 8 · 最大長 128

リクエストボディ

必須application/json

labelstring必須

最小長 1 · 最大長 120

stagesobject[]必須

最小項目数 1 · 最大項目数 3

プロパティを表示

object の配列

approverUserIdstring必須

最小長 1 · 最大長 255

labelstring必須

最小長 1 · 最大長 120

objectIdstring必須

最小長 1 · 最大長 255

versioninteger

最小 1 · 最大 2147483647 · デフォルト: 1

レスポンス

201

The definition was created

idstring必須

最小長 1 · 最大長 255

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 POST '/api/v1/api/v1/approval-definitions' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Idempotency-Key: stringst' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "label": "string",
  "stages": [
    {
      "approverUserId": "string",
      "label": "string"
    }
  ],
  "objectId": "string",
  "version": 1
}'

const response = await fetch("/api/v1/api/v1/approval-definitions", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Idempotency-Key": "stringst",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"label\": \"string\",\n  \"stages\": [\n    {\n      \"approverUserId\": \"string\",\n      \"label\": \"string\"\n    }\n  ],\n  \"objectId\": \"string\",\n  \"version\": 1\n}"
});

import requests

response = requests.post(
    "/api/v1/api/v1/approval-definitions",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Idempotency-Key": "stringst",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"label\": \"string\",\n  \"stages\": [\n    {\n      \"approverUserId\": \"string\",\n      \"label\": \"string\"\n    }\n  ],\n  \"objectId\": \"string\",\n  \"version\": 1\n}",
)

レスポンス

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

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

{
  "error": "string"
}

{
  "error": "string"
}