APIリファレンス

OpenAPI定義ありこの操作へのリンク

プロセスの応答を確認

プロセスの応答を確認。認証不要。固定の稼働状態だけを返す。 認証不要の固定状態応答。業務データを返さない。

認証

この定義に認証指定はありません。環境の条件も確認してください。

操作別の認可条件

json{
  "actor_types": [],
  "authentication": "none",
  "mfa": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "resource_checks": []
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

応答

提供条件: 提供中

制限: この確認用のルートに、専用のレート制限はありません。環境側の制限はあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

基盤と依存先の準備状態を確認

基盤と依存先の準備状態を確認。認証不要。固定の稼働状態だけを返す。 認証不要の固定状態応答。業務データを返さない。

認証

この定義に認証指定はありません。環境の条件も確認してください。

操作別の認可条件

json{
  "actor_types": [],
  "authentication": "none",
  "mfa": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "resource_checks": []
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

応答

提供条件: 提供中

制限: この確認用のルートに、専用のレート制限はありません。環境側の制限はあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

AIセッションを取得

AIセッションを取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 現在権限とMFAでAIセッションを取得する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": true,
  "mfa_when_lifecycle_enabled": true,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "registered_operation_authorization",
      "operation_id": "ai_session.get",
      "checks": [
        "current_roles",
        "resource_scope",
        "field_policy"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string",
  "format": "uuid"
}

応答

提供条件: 提供中（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

行の画像・添付（互換パス）の一覧取得

行の画像・添付（互換パス）の一覧取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 v2行のasset_ref列へ関連付ける。親行・列・所属・原本保持方針を検査し、任意URLを受け付けない。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "v2_media_slot",
      "action": "list",
      "checks": [
        "parent_row",
        "asset_ref_field",
        "membership",
        "field_read_write",
        "current_parent_version",
        "storage_policy"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string"
}

応答

提供条件: 提供中（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

行の画像・添付（互換パス）の保存・参照方針を取得

行の画像・添付（互換パス）の保存・参照方針を取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 v2行のasset_ref列へ関連付ける。親行・列・所属・原本保持方針を検査し、任意URLを受け付けない。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "v2_media_slot",
      "action": "policy",
      "checks": [
        "parent_row",
        "asset_ref_field",
        "membership",
        "field_read_write",
        "current_parent_version",
        "storage_policy"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string"
}

応答

提供条件: 提供中（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

行の画像・添付（互換パス）の関連付けを削除

行の画像・添付（互換パス）の関連付けを削除。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 v2行のasset_ref列へ関連付ける。親行・列・所属・原本保持方針を検査し、任意URLを受け付けない。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": true,
  "mfa_when_lifecycle_enabled": true,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "v2_media_slot",
      "action": "delete",
      "checks": [
        "parent_row",
        "asset_ref_field",
        "membership",
        "field_read_write",
        "current_parent_version",
        "storage_policy"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "write",
  "mode": "Idempotency-Key",
  "identifier": "header.Idempotency-Key",
  "preconditions": [
    "header.If-Match",
    "本文のversion/schema_version/revision/fingerprint（定義される操作のみ）"
  ],
  "safe_to_repeat": true,
  "result_check": "同じキー・本文・前提版で再送し受領結果を確認する。現在権限も再検査する。競合時は最新状態と利用者の意図を照合し、版だけを置換しない。"
}

パラメーター

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string",
  "pattern": "^\"[0-9]{1,9}\"$"
}

json{
  "type": "string",
  "pattern": "^[a-zA-Z0-9_-]{8,128}$"
}

json{
  "type": "integer",
  "minimum": 1,
  "description": "添付先の親行の現在version。表のschema_versionとは別。"
}

json{
  "type": "integer",
  "minimum": 1
}

応答

提供条件: 提供中（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

行の画像・添付（互換パス）のメタデータを取得

行の画像・添付（互換パス）のメタデータを取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 v2行のasset_ref列へ関連付ける。親行・列・所属・原本保持方針を検査し、任意URLを受け付けない。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "v2_media_slot",
      "action": "get",
      "checks": [
        "parent_row",
        "asset_ref_field",
        "membership",
        "field_read_write",
        "current_parent_version",
        "storage_policy"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

応答

提供条件: 提供中（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

行の画像・添付（互換パス）の原本を取得

行の画像・添付（互換パス）の原本を取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 v2行のasset_ref列へ関連付ける。親行・列・所属・原本保持方針を検査し、任意URLを受け付けない。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "v2_media_slot",
      "action": "content",
      "checks": [
        "parent_row",
        "asset_ref_field",
        "membership",
        "field_read_write",
        "current_parent_version",
        "storage_policy"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

応答

提供条件: 提供中（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

行の画像・添付（互換パス）の原本を保存

行の画像・添付（互換パス）の原本を保存。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 v2行のasset_ref列へ関連付ける。親行・列・所属・原本保持方針を検査し、任意URLを受け付けない。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": true,
  "mfa_when_lifecycle_enabled": true,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "v2_media_slot",
      "action": "put",
      "checks": [
        "parent_row",
        "asset_ref_field",
        "membership",
        "field_read_write",
        "current_parent_version",
        "storage_policy"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "write",
  "mode": "Idempotency-Key",
  "identifier": "header.Idempotency-Key",
  "preconditions": [
    "header.If-Match",
    "本文のversion/schema_version/revision/fingerprint（定義される操作のみ）"
  ],
  "safe_to_repeat": true,
  "result_check": "同じキー・本文・前提版で再送し受領結果を確認する。現在権限も再検査する。競合時は最新状態と利用者の意図を照合し、版だけを置換しない。"
}

パラメーター

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string",
  "pattern": "^\"[0-9]{1,9}\"$"
}

json{
  "type": "string",
  "pattern": "^[a-zA-Z0-9_-]{8,128}$"
}

json{
  "type": "integer",
  "minimum": 1,
  "description": "添付先の親行の現在version。表のschema_versionとは別。"
}

json{
  "type": "integer",
  "minimum": 1
}

json{
  "enum": [
    "image/png",
    "image/jpeg",
    "image/webp",
    "application/pdf",
    "text/plain",
    "audio/mpeg",
    "audio/wav",
    "audio/ogg",
    "video/mp4",
    "video/webm"
  ]
}

json{
  "type": "string"
}

リクエスト本文

application/octet-stream

json{
  "type": "string",
  "format": "binary",
  "maxLength": 33554432
}

応答

提供条件: 提供中（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

行の画像・添付（互換パス）の外部原本への参照を登録

行の画像・添付（互換パス）の外部原本への参照を登録。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 v2行のasset_ref列へ関連付ける。親行・列・所属・原本保持方針を検査し、任意URLを受け付けない。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": true,
  "mfa_when_lifecycle_enabled": true,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "v2_media_slot",
      "action": "reference",
      "checks": [
        "parent_row",
        "asset_ref_field",
        "membership",
        "field_read_write",
        "current_parent_version",
        "storage_policy"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "write",
  "mode": "Idempotency-Key",
  "identifier": "header.Idempotency-Key",
  "preconditions": [
    "header.If-Match",
    "本文のversion/schema_version/revision/fingerprint（定義される操作のみ）"
  ],
  "safe_to_repeat": true,
  "result_check": "同じキー・本文・前提版で再送し受領結果を確認する。現在権限も再検査する。競合時は最新状態と利用者の意図を照合し、版だけを置換しない。"
}

パラメーター

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string",
  "pattern": "^\"[0-9]{1,9}\"$"
}

json{
  "type": "string",
  "pattern": "^[a-zA-Z0-9_-]{8,128}$"
}

json{
  "type": "integer",
  "minimum": 1,
  "description": "添付先の親行の現在version。表のschema_versionとは別。"
}

json{
  "type": "integer",
  "minimum": 1
}

リクエスト本文

application/json

json{
  "$ref": "#/components/schemas/MediaReference"
}

応答

提供条件: 提供中（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

行の画像・添付（互換パス）のサムネイルを取得

行の画像・添付（互換パス）のサムネイルを取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 v2行のasset_ref列へ関連付ける。親行・列・所属・原本保持方針を検査し、任意URLを受け付けない。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "v2_media_slot",
      "action": "thumbnail",
      "checks": [
        "parent_row",
        "asset_ref_field",
        "membership",
        "field_read_write",
        "current_parent_version",
        "storage_policy"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

応答

提供条件: 提供中（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

資産の一覧取得

資産の一覧取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 ホストが固定した親資源の読取操作と資産方針で認可する。原本と外部参照を区別し、更新は現在資産版を照合する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "bound_parent_operation",
  "mfa": "binding_dependent",
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "binding_rules": [
    {
      "operation_id": "job.get",
      "mfa": false,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    },
    {
      "operation_id": "invoice.get",
      "mfa": false,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    },
    {
      "operation_id": "contact.erasure_status",
      "mfa": true,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    }
  ],
  "resource_checks": [
    {
      "kind": "parent_resource",
      "action": "list",
      "checks": [
        "parent_read_authorization",
        "asset_policy",
        "can_write_for_upload_or_reference",
        "custody_policy"
      ]
    }
  ],
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "external_human_mfa": true
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string"
}

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "integer",
  "minimum": 1,
  "maximum": 50,
  "default": 25
}

json{
  "type": "integer",
  "minimum": 0,
  "maximum": 100000,
  "default": 0
}

応答

提供条件: 試験提供（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

資産の保存・参照方針を取得

資産の保存・参照方針を取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 ホストが固定した親資源の読取操作と資産方針で認可する。原本と外部参照を区別し、更新は現在資産版を照合する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "bound_parent_operation",
  "mfa": "binding_dependent",
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "binding_rules": [
    {
      "operation_id": "job.get",
      "mfa": false,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    },
    {
      "operation_id": "invoice.get",
      "mfa": false,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    },
    {
      "operation_id": "contact.erasure_status",
      "mfa": true,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    }
  ],
  "resource_checks": [
    {
      "kind": "parent_resource",
      "action": "policy",
      "checks": [
        "parent_read_authorization",
        "asset_policy",
        "can_write_for_upload_or_reference",
        "custody_policy"
      ]
    }
  ],
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "external_human_mfa": true
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string"
}

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "integer",
  "minimum": 1
}

応答

提供条件: 試験提供（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

資産のメタデータを取得

資産のメタデータを取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 ホストが固定した親資源の読取操作と資産方針で認可する。原本と外部参照を区別し、更新は現在資産版を照合する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "bound_parent_operation",
  "mfa": "binding_dependent",
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "binding_rules": [
    {
      "operation_id": "job.get",
      "mfa": false,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    },
    {
      "operation_id": "invoice.get",
      "mfa": false,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    },
    {
      "operation_id": "contact.erasure_status",
      "mfa": true,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    }
  ],
  "resource_checks": [
    {
      "kind": "parent_resource",
      "action": "get",
      "checks": [
        "parent_read_authorization",
        "asset_policy",
        "can_write_for_upload_or_reference",
        "custody_policy"
      ]
    }
  ],
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "external_human_mfa": true
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string"
}

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "integer",
  "minimum": 1
}

応答

提供条件: 試験提供（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

資産の外部原本の現在状態を照合

資産の外部原本の現在状態を照合。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 ホストが固定した親資源の読取操作と資産方針で認可する。原本と外部参照を区別し、更新は現在資産版を照合する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "bound_parent_operation",
  "mfa": "binding_dependent",
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "binding_rules": [
    {
      "operation_id": "job.get",
      "mfa": false,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    },
    {
      "operation_id": "invoice.get",
      "mfa": false,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    },
    {
      "operation_id": "contact.erasure_status",
      "mfa": true,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    }
  ],
  "resource_checks": [
    {
      "kind": "parent_resource",
      "action": "check",
      "checks": [
        "parent_read_authorization",
        "asset_policy",
        "can_write_for_upload_or_reference",
        "custody_policy"
      ]
    }
  ],
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "external_human_mfa": true
}

再送と結果確認

json{
  "effect": "verification",
  "mode": "none",
  "safe_to_repeat": false,
  "result_check": "GET /v1/assets/{namespace}/{resourceType}/{resourceId}/{assetId} で状態を確認。専用の再送識別子・応答再生保証なし。"
}

パラメーター

json{
  "type": "string"
}

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "integer",
  "minimum": 1
}

応答

提供条件: 試験提供（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

資産の原本を取得

資産の原本を取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 ホストが固定した親資源の読取操作と資産方針で認可する。原本と外部参照を区別し、更新は現在資産版を照合する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "bound_parent_operation",
  "mfa": "binding_dependent",
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "binding_rules": [
    {
      "operation_id": "job.get",
      "mfa": false,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    },
    {
      "operation_id": "invoice.get",
      "mfa": false,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    },
    {
      "operation_id": "contact.erasure_status",
      "mfa": true,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    }
  ],
  "resource_checks": [
    {
      "kind": "parent_resource",
      "action": "content",
      "checks": [
        "parent_read_authorization",
        "asset_policy",
        "can_write_for_upload_or_reference",
        "custody_policy"
      ]
    }
  ],
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "external_human_mfa": true
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string"
}

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "integer",
  "minimum": 1
}

応答

提供条件: 試験提供（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

資産の原本を保存

資産の原本を保存。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 ホストが固定した親資源の読取操作と資産方針で認可する。原本と外部参照を区別し、更新は現在資産版を照合する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "bound_parent_operation",
  "mfa": "binding_dependent",
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "binding_rules": [
    {
      "operation_id": "job.get",
      "mfa": false,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    },
    {
      "operation_id": "invoice.get",
      "mfa": false,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    },
    {
      "operation_id": "contact.erasure_status",
      "mfa": true,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    }
  ],
  "resource_checks": [
    {
      "kind": "parent_resource",
      "action": "upload",
      "checks": [
        "parent_read_authorization",
        "asset_policy",
        "can_write_for_upload_or_reference",
        "custody_policy"
      ]
    }
  ],
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "external_human_mfa": true
}

再送と結果確認

json{
  "effect": "write",
  "mode": "Idempotency-Key",
  "identifier": "header.Idempotency-Key",
  "preconditions": [
    "header.If-Match",
    "本文のversion/schema_version/revision/fingerprint（定義される操作のみ）"
  ],
  "safe_to_repeat": true,
  "result_check": "同じキー・本文・前提版で再送し受領結果を確認する。現在権限も再検査する。競合時は最新状態と利用者の意図を照合し、版だけを置換しない。"
}

パラメーター

json{
  "type": "string"
}

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string",
  "pattern": "^\"[0-9]{1,9}\"$"
}

json{
  "type": "string",
  "minLength": 8,
  "maxLength": 128
}

json{
  "type": "string"
}

json{
  "type": "string"
}

リクエスト本文

application/octet-stream

json{
  "type": "string",
  "format": "binary",
  "maxLength": 8388608
}

応答

提供条件: 試験提供（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

資産の外部原本への参照を登録

資産の外部原本への参照を登録。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 ホストが固定した親資源の読取操作と資産方針で認可する。原本と外部参照を区別し、更新は現在資産版を照合する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "bound_parent_operation",
  "mfa": "binding_dependent",
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "binding_rules": [
    {
      "operation_id": "job.get",
      "mfa": false,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    },
    {
      "operation_id": "invoice.get",
      "mfa": false,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    },
    {
      "operation_id": "contact.erasure_status",
      "mfa": true,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    }
  ],
  "resource_checks": [
    {
      "kind": "parent_resource",
      "action": "reference",
      "checks": [
        "parent_read_authorization",
        "asset_policy",
        "can_write_for_upload_or_reference",
        "custody_policy"
      ]
    }
  ],
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "external_human_mfa": true
}

再送と結果確認

json{
  "effect": "write",
  "mode": "Idempotency-Key",
  "identifier": "header.Idempotency-Key",
  "preconditions": [
    "header.If-Match",
    "本文のversion/schema_version/revision/fingerprint（定義される操作のみ）"
  ],
  "safe_to_repeat": true,
  "result_check": "同じキー・本文・前提版で再送し受領結果を確認する。現在権限も再検査する。競合時は最新状態と利用者の意図を照合し、版だけを置換しない。"
}

パラメーター

json{
  "type": "string"
}

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string",
  "pattern": "^\"[0-9]{1,9}\"$"
}

json{
  "type": "string",
  "minLength": 8,
  "maxLength": 128
}

json{
  "type": "string"
}

リクエスト本文

application/json

json{
  "$ref": "#/components/schemas/AssetReference"
}

応答

提供条件: 試験提供（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

資産のサムネイルを取得

資産のサムネイルを取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 ホストが固定した親資源の読取操作と資産方針で認可する。原本と外部参照を区別し、更新は現在資産版を照合する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "bound_parent_operation",
  "mfa": "binding_dependent",
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "binding_rules": [
    {
      "operation_id": "job.get",
      "mfa": false,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    },
    {
      "operation_id": "invoice.get",
      "mfa": false,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    },
    {
      "operation_id": "contact.erasure_status",
      "mfa": true,
      "maxAuthenticationAgeSeconds": null,
      "requiredCapabilities": [],
      "countsAsSessionActivity": false
    }
  ],
  "resource_checks": [
    {
      "kind": "parent_resource",
      "action": "thumbnail",
      "checks": [
        "parent_read_authorization",
        "asset_policy",
        "can_write_for_upload_or_reference",
        "custody_policy"
      ]
    }
  ],
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "external_human_mfa": true
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string"
}

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "integer",
  "minimum": 1
}

応答

提供条件: 試験提供（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

連絡先の消去状況を取得

連絡先の消去状況を取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 現在権限で消去状態を取得する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": true,
  "mfa_when_lifecycle_enabled": true,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "registered_operation_authorization",
      "operation_id": "contact.erasure_status",
      "checks": [
        "current_roles",
        "resource_scope",
        "field_policy"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string",
  "format": "uuid"
}

応答

提供条件: 提供中（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

請求書を取得

請求書を取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 現在権限で請求書を取得する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "registered_operation_authorization",
      "operation_id": "invoice.get",
      "checks": [
        "current_roles",
        "resource_scope",
        "field_policy"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string",
  "format": "uuid"
}

応答

提供条件: 提供中（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

ケースを一覧取得

ケースを一覧取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 現在のケース権限と業務状態を検査する。status_codeは表のdraft/committedとは別。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "registered_operation_authorization",
      "operation_id": "job.list",
      "checks": [
        "current_roles",
        "resource_scope",
        "field_policy"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string",
  "minLength": 1,
  "maxLength": 128
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string",
  "minLength": 1,
  "maxLength": 256
}

json{
  "type": "string",
  "pattern": "^[a-z][a-z0-9_]*$"
}

json{
  "type": "string",
  "pattern": "^(?:[1-9]|[1-9][0-9]|1[0-9]{2})$"
}

応答

提供条件: 提供中（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

ケースを新規作成

ケースを新規作成。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 現在のケース権限と業務状態を検査する。status_codeは表のdraft/committedとは別。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "registered_operation_authorization",
      "operation_id": "job.create",
      "checks": [
        "current_roles",
        "resource_scope",
        "field_policy",
        "write_preconditions"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "write",
  "mode": "Idempotency-Key",
  "identifier": "header.Idempotency-Key",
  "preconditions": [
    "本文のversion/schema_version/revision/fingerprint（定義される操作のみ）"
  ],
  "safe_to_repeat": true,
  "result_check": "同じキー・本文・前提版で再送し受領結果を確認する。現在権限も再検査する。競合時は最新状態と利用者の意図を照合し、版だけを置換しない。"
}

パラメーター

json{
  "type": "string"
}

リクエスト本文

application/json

json{
  "type": "object",
  "properties": {
    "job_number": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "customer_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ]
    },
    "department_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ]
    },
    "sales_rep_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ]
    },
    "production_rep_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ]
    },
    "entry_route": {
      "type": "string",
      "minLength": 1
    },
    "status_code": {
      "type": "string",
      "pattern": "^[a-z][a-z0-9_]*$"
    },
    "site_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "media_note": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "notes": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "job_number",
    "entry_route",
    "status_code"
  ],
  "additionalProperties": false
}

応答

提供条件: 提供中（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

ケース数を取得

ケース数を取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 現在のケース権限と業務状態を検査する。status_codeは表のdraft/committedとは別。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "registered_operation_authorization",
      "operation_id": "job.count",
      "checks": [
        "current_roles",
        "resource_scope",
        "field_policy"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string",
  "minLength": 1,
  "maxLength": 128
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string",
  "minLength": 1,
  "maxLength": 256
}

json{
  "type": "string",
  "pattern": "^[a-z][a-z0-9_]*$"
}

応答

提供条件: 提供中（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

ケースをエクスポート

ケースをエクスポート。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 現在のケース権限と業務状態を検査する。status_codeは表のdraft/committedとは別。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "registered_operation_authorization",
      "operation_id": "job.export",
      "checks": [
        "current_roles",
        "resource_scope",
        "field_policy"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string",
  "minLength": 1,
  "maxLength": 128
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string",
  "minLength": 1,
  "maxLength": 256
}

json{
  "type": "string",
  "pattern": "^[a-z][a-z0-9_]*$"
}

json{
  "type": "string",
  "pattern": "^(?:[1-9]|[1-9][0-9]|1[0-9]{2})$"
}

応答

提供条件: 提供中（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

ケースを削除

ケースを削除。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 現在のケース権限と業務状態を検査する。status_codeは表のdraft/committedとは別。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "registered_operation_authorization",
      "operation_id": "job.delete",
      "checks": [
        "current_roles",
        "resource_scope",
        "field_policy",
        "write_preconditions"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "write",
  "mode": "Idempotency-Key",
  "identifier": "header.Idempotency-Key",
  "preconditions": [
    "header.If-Match",
    "本文のversion/schema_version/revision/fingerprint（定義される操作のみ）"
  ],
  "safe_to_repeat": true,
  "result_check": "同じキー・本文・前提版で再送し受領結果を確認する。現在権限も再検査する。競合時は最新状態と利用者の意図を照合し、版だけを置換しない。"
}

パラメーター

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string"
}

json{
  "type": "string"
}

応答

提供条件: 提供中（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

ケースを1件取得

ケースを1件取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 現在のケース権限と業務状態を検査する。status_codeは表のdraft/committedとは別。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "registered_operation_authorization",
      "operation_id": "job.get",
      "checks": [
        "current_roles",
        "resource_scope",
        "field_policy"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string",
  "format": "uuid"
}

応答

提供条件: 提供中（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

ケースの指定項目を更新

ケースの指定項目を更新。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 現在のケース権限と業務状態を検査する。status_codeは表のdraft/committedとは別。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "registered_operation_authorization",
      "operation_id": "job.update",
      "checks": [
        "current_roles",
        "resource_scope",
        "field_policy",
        "write_preconditions"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "write",
  "mode": "Idempotency-Key",
  "identifier": "header.Idempotency-Key",
  "preconditions": [
    "header.If-Match",
    "本文のversion/schema_version/revision/fingerprint（定義される操作のみ）"
  ],
  "safe_to_repeat": true,
  "result_check": "同じキー・本文・前提版で再送し受領結果を確認する。現在権限も再検査する。競合時は最新状態と利用者の意図を照合し、版だけを置換しない。"
}

パラメーター

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string"
}

json{
  "type": "string"
}

リクエスト本文

application/merge-patch+json

json{
  "type": "object",
  "properties": {
    "status_code": {
      "type": "string",
      "pattern": "^[a-z][a-z0-9_]*$"
    },
    "site_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "media_note": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "notes": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [],
  "additionalProperties": false,
  "minProperties": 1
}

応答

提供条件: 提供中（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

ログイン中の本人情報と現在権限を取得

ログイン中の本人情報と現在権限を取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 本人と現在セッションの境界を維持する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "registered_operation_authorization",
      "operation_id": "identity.me",
      "checks": [
        "current_roles",
        "resource_scope",
        "field_policy"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

応答

提供条件: 提供中（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

承認提案を取得

承認提案を取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 現在権限で承認提案を取得する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "registered_operation_authorization",
      "operation_id": "proposal.get",
      "checks": [
        "current_roles",
        "resource_scope",
        "field_policy"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string",
  "format": "uuid"
}

応答

提供条件: 提供中（環境による）

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

v1の利用可能な表を一覧取得

v1の利用可能な表を一覧取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 現在の表利用権と列権限で処理する。v1の行version、表revision、schema_version、共有viewの版を区別する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "v1_table_grant",
      "action": "list",
      "checks": [
        "current_role",
        "field_read_write",
        "row_visibility"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

応答

提供条件: 試験提供（環境による）

制限: 同時2要求まで。固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

v1の表定義と列の権限を取得

v1の表定義と列の権限を取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 現在の表利用権と列権限で処理する。v1の行version、表revision、schema_version、共有viewの版を区別する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "v1_table_grant",
      "action": "definition",
      "checks": [
        "current_role",
        "field_read_write",
        "row_visibility"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string",
  "pattern": "^[a-z][a-z0-9_-]{0,47}$"
}

応答

提供条件: 試験提供（環境による）

制限: 同時2要求まで。固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

v1の表定義を作成・更新

v1の表定義を作成・更新。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 現在の表利用権と列権限で処理する。v1の行version、表revision、schema_version、共有viewの版を区別する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "v1_table_grant",
      "action": "define",
      "checks": [
        "current_role",
        "field_read_write",
        "row_visibility",
        "designer"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "write",
  "mode": "Idempotency-Key",
  "identifier": "header.Idempotency-Key",
  "preconditions": [
    "header.If-Match",
    "本文のversion/schema_version/revision/fingerprint（定義される操作のみ）"
  ],
  "safe_to_repeat": true,
  "result_check": "同じキー・本文・前提版で再送し受領結果を確認する。現在権限も再検査する。競合時は最新状態と利用者の意図を照合し、版だけを置換しない。"
}

パラメーター

json{
  "type": "string",
  "pattern": "^[a-z][a-z0-9_-]{0,47}$"
}

json{
  "type": "string",
  "pattern": "^[-a-zA-Z0-9_]{8,128}$"
}

json{
  "type": "string",
  "pattern": "^\"[0-9]+\"$"
}

リクエスト本文

application/json

json{
  "$ref": "#/components/schemas/Define"
}

応答

提供条件: 試験提供（環境による）

制限: 同時2要求まで。固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

v1の行を一括作成・更新・削除

v1の行を一括作成・更新・削除。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 現在の表利用権と列権限で処理する。v1の行version、表revision、schema_version、共有viewの版を区別する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "v1_table_grant",
      "action": "batch",
      "checks": [
        "current_role",
        "field_read_write",
        "row_visibility"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "write",
  "mode": "Idempotency-Key",
  "identifier": "header.Idempotency-Key",
  "preconditions": [
    "本文のversion/schema_version/revision/fingerprint（定義される操作のみ）"
  ],
  "safe_to_repeat": true,
  "result_check": "同じキー・本文・前提版で再送し受領結果を確認する。現在権限も再検査する。競合時は最新状態と利用者の意図を照合し、版だけを置換しない。"
}

パラメーター

json{
  "type": "string",
  "pattern": "^[a-z][a-z0-9_-]{0,47}$"
}

json{
  "type": "string",
  "pattern": "^[-a-zA-Z0-9_]{8,128}$"
}

リクエスト本文

application/json

json{
  "$ref": "#/components/schemas/Batch"
}

応答

提供条件: 試験提供（環境による）

制限: 同時2要求まで。固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

v1の表の変更版を取得

v1の表の変更版を取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 現在の表利用権と列権限で処理する。v1の行version、表revision、schema_version、共有viewの版を区別する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "v1_table_grant",
      "action": "changes",
      "checks": [
        "current_role",
        "field_read_write",
        "row_visibility"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string",
  "pattern": "^[a-z][a-z0-9_-]{0,47}$"
}

応答

提供条件: 試験提供（環境による）

制限: 同時2要求まで。固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

v1のCSVを取得

v1のCSVを取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 現在の表利用権と列権限で処理する。v1の行version、表revision、schema_version、共有viewの版を区別する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "v1_table_grant",
      "action": "export",
      "checks": [
        "current_role",
        "field_read_write",
        "row_visibility",
        "export_role"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string",
  "pattern": "^[a-z][a-z0-9_-]{0,47}$"
}

リクエスト本文

application/json

json{
  "$ref": "#/components/schemas/Query"
}

応答

提供条件: 試験提供（環境による）

制限: 同時2要求まで。固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

v1のCSVを検査・反映

v1のCSVを検査・反映。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 現在の表利用権と列権限で処理する。v1の行version、表revision、schema_version、共有viewの版を区別する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "v1_table_grant",
      "action": "import",
      "checks": [
        "current_role",
        "field_read_write",
        "row_visibility"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "write",
  "mode": "Idempotency-Key",
  "identifier": "header.Idempotency-Key",
  "preconditions": [
    "本文のversion/schema_version/revision/fingerprint（定義される操作のみ）"
  ],
  "safe_to_repeat": true,
  "result_check": "同じキー・本文・前提版で再送し受領結果を確認する。現在権限も再検査する。競合時は最新状態と利用者の意図を照合し、版だけを置換しない。"
}

パラメーター

json{
  "type": "string",
  "pattern": "^[a-z][a-z0-9_-]{0,47}$"
}

json{
  "type": "string",
  "pattern": "^[-a-zA-Z0-9_]{8,128}$"
}

リクエスト本文

application/json

json{
  "$ref": "#/components/schemas/Import"
}

応答

提供条件: 試験提供（環境による）

制限: 同時2要求まで。固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

v1の行を検索

v1の行を検索。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 現在の表利用権と列権限で処理する。v1の行version、表revision、schema_version、共有viewの版を区別する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "v1_table_grant",
      "action": "query",
      "checks": [
        "current_role",
        "field_read_write",
        "row_visibility"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string",
  "pattern": "^[a-z][a-z0-9_-]{0,47}$"
}

リクエスト本文

application/json

json{
  "$ref": "#/components/schemas/Query"
}

応答

提供条件: 試験提供（環境による）

制限: 同時2要求まで。固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

v1の行を1件取得

v1の行を1件取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 現在の表利用権と列権限で処理する。v1の行version、表revision、schema_version、共有viewの版を区別する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "v1_table_grant",
      "action": "row",
      "checks": [
        "current_role",
        "field_read_write",
        "row_visibility"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string",
  "pattern": "^[a-z][a-z0-9_-]{0,47}$"
}

json{
  "type": "string",
  "format": "uuid"
}

応答

提供条件: 試験提供（環境による）

制限: 同時2要求まで。固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

v1の共有ビューを取得

v1の共有ビューを取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 現在の表利用権と列権限で処理する。v1の行version、表revision、schema_version、共有viewの版を区別する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "v1_table_grant",
      "action": "views",
      "checks": [
        "current_role",
        "field_read_write",
        "row_visibility"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string",
  "pattern": "^[a-z][a-z0-9_-]{0,47}$"
}

応答

提供条件: 試験提供（環境による）

制限: 同時2要求まで。固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

v1の共有ビューを保存

v1の共有ビューを保存。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 現在の表利用権と列権限で処理する。v1の行version、表revision、schema_version、共有viewの版を区別する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": false,
  "mfa_when_lifecycle_enabled": false,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": false,
  "resource_checks": [
    {
      "kind": "v1_table_grant",
      "action": "view",
      "checks": [
        "current_role",
        "field_read_write",
        "row_visibility",
        "designer"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "write",
  "mode": "Idempotency-Key",
  "identifier": "header.Idempotency-Key",
  "preconditions": [
    "本文のversion/schema_version/revision/fingerprint（定義される操作のみ）"
  ],
  "safe_to_repeat": true,
  "result_check": "同じキー・本文・前提版で再送し受領結果を確認する。現在権限も再検査する。競合時は最新状態と利用者の意図を照合し、版だけを置換しない。"
}

パラメーター

json{
  "type": "string",
  "pattern": "^[a-z][a-z0-9_-]{0,47}$"
}

json{
  "type": "string",
  "pattern": "^[-a-zA-Z0-9_]{8,128}$"
}

リクエスト本文

application/json

json{
  "$ref": "#/components/schemas/ViewInput"
}

応答

提供条件: 試験提供（環境による）

制限: 同時2要求まで。固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

本人の行削除範囲を取得

本人の行削除範囲を取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 管理権限は業務行の閲覧権を付与しない。人物対応は明示された本人IDと人物行を使い、名前や行所有者から推測しない。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": true,
  "mfa_when_lifecycle_enabled": true,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": true,
  "resource_checks": [
    {
      "kind": "management",
      "all_of": [
        "service_administrator",
        "manage_access"
      ],
      "action": "deleteGet"
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string"
}

応答

提供条件: 環境による

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

本人の行削除範囲を設定

本人の行削除範囲を設定。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 管理権限は業務行の閲覧権を付与しない。人物対応は明示された本人IDと人物行を使い、名前や行所有者から推測しない。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": true,
  "mfa_when_lifecycle_enabled": true,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": true,
  "resource_checks": [
    {
      "kind": "management",
      "all_of": [
        "service_administrator",
        "manage_access"
      ],
      "action": "deletePut"
    }
  ]
}

再送と結果確認

json{
  "effect": "write",
  "mode": "Idempotency-Key",
  "identifier": "header.Idempotency-Key",
  "preconditions": [
    "本文のversion/schema_version/revision/fingerprint（定義される操作のみ）"
  ],
  "safe_to_repeat": true,
  "result_check": "同じキー・本文・前提版で再送し受領結果を確認する。現在権限も再検査する。競合時は最新状態と利用者の意図を照合し、版だけを置換しない。"
}

パラメーター

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string"
}

json{
  "type": "string",
  "pattern": "^[-a-zA-Z0-9_]{8,128}$"
}

リクエスト本文

application/json

json{
  "$ref": "#/components/schemas/HumanDeleteInput"
}

応答

提供条件: 環境による

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

本人の表利用権を取得

本人の表利用権を取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 管理操作は登録済みMFA本人、機械操作は専用audienceのservice資格を使う。人のJWTを機械経路へ流用しない。changeはversion必須で、rotateのみjwkが必要。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": true,
  "mfa_when_lifecycle_enabled": true,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": true,
  "resource_checks": [
    {
      "kind": "management",
      "all_of": [
        "service_administrator",
        "manage_access"
      ],
      "action": "grantGet"
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string"
}

応答

提供条件: 環境による

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

本人の表利用権を設定

本人の表利用権を設定。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 管理操作は登録済みMFA本人、機械操作は専用audienceのservice資格を使う。人のJWTを機械経路へ流用しない。changeはversion必須で、rotateのみjwkが必要。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": true,
  "mfa_when_lifecycle_enabled": true,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": true,
  "resource_checks": [
    {
      "kind": "management",
      "all_of": [
        "service_administrator",
        "manage_access"
      ],
      "action": "grantPut"
    }
  ]
}

再送と結果確認

json{
  "effect": "write",
  "mode": "version",
  "identifier": "body.version",
  "safe_to_repeat": false,
  "result_check": "GET /v2/access/grants/{subjectId}/{collection} で現在版・状態・対象値を確認。版は競合検出であり応答再生キーではない。未確定ならrequest_idで照会し、最新版を自動採用して再送しない。"
}

パラメーター

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string"
}

リクエスト本文

application/json

json{
  "$ref": "#/components/schemas/AccessGrantInput"
}

応答

提供条件: 環境による

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

人物表の登録状態を取得

人物表の登録状態を取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 管理権限は業務行の閲覧権を付与しない。人物対応は明示された本人IDと人物行を使い、名前や行所有者から推測しない。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": true,
  "mfa_when_lifecycle_enabled": true,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": true,
  "resource_checks": [
    {
      "kind": "management",
      "all_of": [
        "service_administrator",
        "manage_access"
      ],
      "action": "rootGet"
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string"
}

応答

提供条件: 環境による

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

人物表を登録

人物表を登録。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 管理権限は業務行の閲覧権を付与しない。人物対応は明示された本人IDと人物行を使い、名前や行所有者から推測しない。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": true,
  "mfa_when_lifecycle_enabled": true,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": true,
  "resource_checks": [
    {
      "kind": "management",
      "all_of": [
        "service_administrator",
        "manage_access"
      ],
      "action": "rootPut"
    }
  ]
}

再送と結果確認

json{
  "effect": "write",
  "mode": "Idempotency-Key",
  "identifier": "header.Idempotency-Key",
  "preconditions": [
    "本文のversion/schema_version/revision/fingerprint（定義される操作のみ）"
  ],
  "safe_to_repeat": true,
  "result_check": "同じキー・本文・前提版で再送し受領結果を確認する。現在権限も再検査する。競合時は最新状態と利用者の意図を照合し、版だけを置換しない。"
}

パラメーター

json{
  "type": "string"
}

json{
  "type": "string",
  "pattern": "^[-a-zA-Z0-9_]{8,128}$"
}

リクエスト本文

application/json

json{
  "$ref": "#/components/schemas/PersonRootInput"
}

応答

提供条件: 環境による

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

本人IDと人物行の対応を取得

本人IDと人物行の対応を取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 管理権限は業務行の閲覧権を付与しない。人物対応は明示された本人IDと人物行を使い、名前や行所有者から推測しない。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": true,
  "mfa_when_lifecycle_enabled": true,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": true,
  "resource_checks": [
    {
      "kind": "management",
      "all_of": [
        "service_administrator",
        "manage_access"
      ],
      "action": "bindingGet"
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

応答

提供条件: 環境による

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

本人IDと人物行の対応を設定

本人IDと人物行の対応を設定。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 管理権限は業務行の閲覧権を付与しない。人物対応は明示された本人IDと人物行を使い、名前や行所有者から推測しない。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": true,
  "mfa_when_lifecycle_enabled": true,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": true,
  "resource_checks": [
    {
      "kind": "management",
      "all_of": [
        "service_administrator",
        "manage_access"
      ],
      "action": "bindingPut"
    }
  ]
}

再送と結果確認

json{
  "effect": "write",
  "mode": "Idempotency-Key",
  "identifier": "header.Idempotency-Key",
  "preconditions": [
    "本文のversion/schema_version/revision/fingerprint（定義される操作のみ）"
  ],
  "safe_to_repeat": true,
  "result_check": "同じキー・本文・前提版で再送し受領結果を確認する。現在権限も再検査する。競合時は最新状態と利用者の意図を照合し、版だけを置換しない。"
}

パラメーター

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string",
  "pattern": "^[-a-zA-Z0-9_]{8,128}$"
}

リクエスト本文

application/json

json{
  "$ref": "#/components/schemas/PersonBindingInput"
}

応答

提供条件: 環境による

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

人物行の所属者を取得

人物行の所属者を取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 管理権限は業務行の閲覧権を付与しない。人物対応は明示された本人IDと人物行を使い、名前や行所有者から推測しない。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": true,
  "mfa_when_lifecycle_enabled": true,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": true,
  "resource_checks": [
    {
      "kind": "management",
      "all_of": [
        "service_administrator",
        "manage_access"
      ],
      "action": "membersGet"
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "integer",
  "minimum": 1,
  "maximum": 100
}

json{
  "type": "string",
  "format": "uuid"
}

応答

提供条件: 環境による

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

人物行の所属者を設定

人物行の所属者を設定。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 管理権限は業務行の閲覧権を付与しない。人物対応は明示された本人IDと人物行を使い、名前や行所有者から推測しない。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": true,
  "mfa_when_lifecycle_enabled": true,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": true,
  "resource_checks": [
    {
      "kind": "management",
      "all_of": [
        "service_administrator",
        "manage_access"
      ],
      "action": "membersPut"
    }
  ]
}

再送と結果確認

json{
  "effect": "write",
  "mode": "Idempotency-Key",
  "identifier": "header.Idempotency-Key",
  "preconditions": [
    "本文のversion/schema_version/revision/fingerprint（定義される操作のみ）"
  ],
  "safe_to_repeat": true,
  "result_check": "同じキー・本文・前提版で再送し受領結果を確認する。現在権限も再検査する。競合時は最新状態と利用者の意図を照合し、版だけを置換しない。"
}

パラメーター

json{
  "type": "string"
}

json{
  "type": "string",
  "format": "uuid"
}

json{
  "type": "string",
  "pattern": "^[-a-zA-Z0-9_]{8,128}$"
}

リクエスト本文

application/json

json{
  "$ref": "#/components/schemas/PersonMembersInput"
}

応答

提供条件: 環境による

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

権限管理対象の本人IDを一覧取得

権限管理対象の本人IDを一覧取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 管理操作は登録済みMFA本人、機械操作は専用audienceのservice資格を使う。人のJWTを機械経路へ流用しない。changeはversion必須で、rotateのみjwkが必要。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": true,
  "mfa_when_lifecycle_enabled": true,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": true,
  "resource_checks": [
    {
      "kind": "management",
      "all_of": [
        "service_administrator",
        "manage_access"
      ],
      "action": "subjects"
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "integer",
  "minimum": 1,
  "maximum": 100
}

json{
  "type": "string",
  "format": "uuid"
}

応答

提供条件: 環境による

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

権限管理対象の表を一覧取得

権限管理対象の表を一覧取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 管理操作は登録済みMFA本人、機械操作は専用audienceのservice資格を使う。人のJWTを機械経路へ流用しない。changeはversion必須で、rotateのみjwkが必要。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": true,
  "mfa_when_lifecycle_enabled": true,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": true,
  "resource_checks": [
    {
      "kind": "management",
      "all_of": [
        "service_administrator",
        "manage_access"
      ],
      "action": "tables"
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "integer",
  "minimum": 1,
  "maximum": 100
}

json{
  "type": "string"
}

応答

提供条件: 環境による

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

権限設定用の表定義を取得

権限設定用の表定義を取得。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 管理操作は登録済みMFA本人、機械操作は専用audienceのservice資格を使う。人のJWTを機械経路へ流用しない。changeはversion必須で、rotateのみjwkが必要。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": true,
  "mfa_when_lifecycle_enabled": true,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": true,
  "resource_checks": [
    {
      "kind": "management",
      "all_of": [
        "service_administrator",
        "manage_access"
      ],
      "action": "definition"
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

パラメーター

json{
  "type": "string"
}

応答

提供条件: 環境による

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

確認済みの既存アプリ台帳を採用

確認済みの既存アプリ台帳を採用。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 アプリとCSV契約・接続要件・移行の操作。計画を確認してからfingerprintを変えず適用する。空のcsvは対象アプリの取込形式を明示的に無効化する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": true,
  "mfa_when_lifecycle_enabled": true,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": true,
  "resource_checks": [
    {
      "kind": "management",
      "all_of": [
        "service_administrator",
        "manage_access"
      ],
      "action": "adoptionApply"
    },
    {
      "kind": "affected_tables",
      "checks": [
        "current_design_grants",
        "dependency_state"
      ]
    }
  ]
}

再送と結果確認

json{
  "effect": "write",
  "mode": "fingerprint",
  "identifier": "body.migration.migration_id + body.fingerprint",
  "required_header": "Idempotency-Key（形式検査のみ。受領の識別子ではない）",
  "safe_to_repeat": true,
  "result_check": "同じ主体・移行ID・本文・fingerprintで再送しadoption受領を確認。入力を変更した再送は拒否される。対象アプリのGETでも状態を照合する。"
}

パラメーター

json{
  "type": "string",
  "pattern": "^[-a-zA-Z0-9_]{8,128}$"
}

リクエスト本文

application/json

json{
  "type": "object",
  "properties": {
    "migration": {
      "type": "object",
      "properties": {
        "migration_id": {
          "type": "string",
          "format": "uuid"
        },
        "source_fingerprint": {
          "type": "string",
          "pattern": "^[0-9a-f]{64}$"
        },
        "apps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "package": {
                "type": "object",
                "properties": {
                  "manifest": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string"
                      },
                      "version": {
                        "type": "integer",
                        "minimum": 1
                      },
                      "name": {
                        "type": "string"
                      },
                      "datasets": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string"
                            },
                            "mode": {
                              "enum": [
                                "owned",
                                "shared"
                              ]
                            },
                            "definition": {
                              "$ref": "#/components/schemas/WorkspaceDefine"
                            }
                          },
                          "required": [
                            "id",
                            "mode",
                            "definition"
                          ],
                          "additionalProperties": false
                        },
                        "maxItems": 32,
                        "minItems": 1
                      },
                      "dependencies": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        },
                        "maxItems": 32,
                        "uniqueItems": true
                      }
                    },
                    "required": [
                      "id",
                      "version",
                      "name",
                      "datasets",
                      "dependencies"
                    ],
                    "additionalProperties": false
                  },
                  "csv": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "collection": {
                          "type": "string"
                        },
                        "key_fields": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          },
                          "maxItems": 64,
                          "minItems": 1,
                          "uniqueItems": true
                        }
                      },
                      "required": [
                        "collection",
                        "key_fields"
                      ],
                      "additionalProperties": false
                    },
                    "maxItems": 32
                  },
                  "requirements": {
                    "type": "object",
                    "properties": {
                      "dependencies": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string"
                            },
                            "min_version": {
                              "type": "integer",
                              "minimum": 1
                            }
                          },
                          "required": [
                            "id",
                            "min_version"
                          ],
                          "additionalProperties": false
                        },
                        "maxItems": 32
                      },
                      "integrations": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        },
                        "maxItems": 16
                      },
                      "service_clients": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "format": "uuid"
                        },
                        "maxItems": 16
                      }
                    },
                    "required": [
                      "dependencies",
                      "integrations",
                      "service_clients"
                    ],
                    "additionalProperties": false
                  }
                },
                "required": [
                  "manifest",
                  "csv"
                ],
                "additionalProperties": false
              },
              "revision": {
                "type": "integer",
                "minimum": 1
              },
              "state": {
                "enum": [
                  "active",
                  "stopped",
                  "detached"
                ]
              },
              "legacy_state": {
                "enum": [
                  "registered",
                  "stopped",
                  "detached",
                  "awaiting_activation",
                  "awaiting_integration"
                ]
              }
            },
            "required": [
              "package",
              "revision",
              "state",
              "legacy_state"
            ],
            "additionalProperties": false
          },
          "maxItems": 64
        }
      },
      "required": [
        "migration_id",
        "source_fingerprint",
        "apps"
      ],
      "additionalProperties": false
    },
    "fingerprint": {
      "type": "string",
      "pattern": "^[0-9a-f]{64}$"
    }
  },
  "required": [
    "migration",
    "fingerprint"
  ],
  "additionalProperties": false
}

応答

提供条件: 環境による

制限: 固定のレート上限は定めていません。環境側の制限があり、429が返ることがあります。

完全な要求・応答と実行例 · 状態の読み方

OpenAPI定義ありこの操作へのリンク

既存アプリ台帳の採用を計画

既存アプリ台帳の採用を計画。登録された人のaccess tokenと現在権限を検査する。操作固有のMFA・管理権・データ権が追加で必要。 アプリとCSV契約・接続要件・移行の操作。計画を確認してからfingerprintを変えず適用する。空のcsvは対象アプリの取込形式を明示的に無効化する。

認証

Bearer JWT。主体と現在権限を確認します。

操作別の認可条件

json{
  "actor_types": [
    "human"
  ],
  "authentication": "current_identity",
  "mfa": true,
  "mfa_when_lifecycle_enabled": true,
  "required_capabilities": [],
  "max_authentication_age_seconds": null,
  "external_human_mfa": true,
  "identity_freshness": {
    "checked_age_seconds": 5,
    "reconciled_age_seconds": 60
  },
  "administrative_session_when_lifecycle_enabled": true,
  "resource_checks": [
    {
      "kind": "management",
      "all_of": [
        "service_administrator",
        "manage_access"
      ],
      "action": "adoptionPlan"
    }
  ]
}

再送と結果確認

json{
  "effect": "read_or_plan",
  "mode": "none",
  "safe_to_repeat": true,
  "result_check": "同じ条件で取得可能。ただし一覧・計画・cursor・fingerprintは現在状態で変化する。計画を再取得しても適用は行わない。"
}

リクエスト本文

application/json

json{
  "type": "object",
  "properties": {
    "migration_id": {
      "type": "string",
      "format": "uuid"
    },
    "source_fingerprint": {
      "type": "string",
      "pattern": "^[0-9a-f]{64}$"
    },
    "apps": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "package": {
            "type": "object",
            "properties": {
              "manifest": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "version": {
                    "type": "integer",
                    "minimum": 1
                  },
                  "name": {
                    "type": "string"
                  },
                  "datasets": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "mode": {
                          "enum": [
                            "owned",
                            "shared"
                          ]
                        },
                        "definition": {
                          "$ref": "#/components/schemas/WorkspaceDefine"
                        }
                      },
                      "required": [
                        "id",
                        "mode",
                        "definition"
                      ],
                      "additionalProperties": false
                    },
                    "maxItems": 32,
                    "minItems": 1
                  },
                  "dependencies": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "maxItems": 32,
                    "uniqueItems": true
                  }
                },
                "required": [
                  "id",
                  "version",
                  "name",
                  "datasets",
                  "dependencies"
                ],
                "additionalProperties": false
              },
              "csv": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "collection": {
                      "type": "string"
                    },
                    "key_fields": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "maxItems": 64,
                      "minItems": 1,
                      "uniqueItems": true
                    }
                  },
                  "required": [
                    "collection",
                    "key_fields"
                  ],
                  "additionalProperties": false
                },
                "maxItems": 32
              },
              "requirements": {
                "type": "object",
                "properties": {
                  "dependencies": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "min_version": {
                          "type": "integer",
                          "minimum": 1
                        }
                      },
                      "required": [
                        "id",
                        "min_version"
                      ],
                      "additionalProperties": false
                    },
                    "maxItems": 32
                  },
                  "integrations": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "maxItems": 16
                  },
                  "service_clients": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "maxItems": 16
                  }
                },
                "required": [
                  "dependencies",
                  "integrations",
                  "service_clients"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "manifest",
              "csv"
            ],
            "additionalProperties": false
          },
          "revision": {
            "type": "integer",
            "minimum": 1
          },
          "state": {
            "enum": [
              "active",
              "stopped",
              "detached"
            ]
          },
          "legacy_state": {
            "enum": [
              "registered",
              "stopped",
              "detached",
              "awaiting_activation",
              "awaiting_integration"
            ]
          }
        },
        "required": [
          "package",
          "revision",
          "state",
          "legacy_state"
        ],
        "additionalProperties": false
      },
      "maxItems": 64
    }
  },
  "required": [
    "migration_id",
    "source_fingerprint",
    "apps"
  ],
  "additionalProperties": false
}

応答