ID、Public ID、チケット番号、コードの違いを教えて下さい
kickflowの組織データ(ユーザー、チーム、所属)や経路データに含まれるID、Public ID、コードは以下のような違いがあります。
ID
- システムがリソースに対して自動で付与するユニークなIDです。すべてのテナントを横断してユニークなUUIDになります。
- 原則として、画面上では表示されません。
- 例外として、チケットのIDのみURLで使用されます。
- REST APIでは、パスパラメータ、クエリ、ボディでリソースを指定する際に使用できます。
- パスパラメータの例
-
/users/550e8400-e29b-41d4-a716-446655440000
-
- クエリの例
-
/tickets?workflowId=550e8400-e29b-41d4-a716-446655440000
-
- ボディの例
-
{ userId: "550e8400-e29b-41d4-a716-446655440000" }
-
- パスパラメータの例
Public ID
- IDと同じく、システムがリソースに対して自動で付与するユニークなIDです。テナント内のデータ構造ごとに連番で発行される整数になります。
- 一部のリソースに対しては発行されません。
- 画面上で表示されるほか、URLの一部として使用されます。
- REST APIでは、リソースの指定に使用できません。
チケット番号
- チケットにのみ採番される、ユーザーが識別するための文字列です。同じワークフローで作成されたチケット内でユニークになります。
- 任意のフォーマットで採番可能です。詳しくはこちらのヘルプをご確認ください。
- 画面上で表示されます。
- REST APIでは、リソースの指定に使用できません。
コード
- ユーザーが付与可能な、テナント内のデータ構造ごとにユニークなキーになります。
- ユーザーが付与しない場合、システムが自動でランダムな英数字を付与します。
- 管理画面上でのみ表示されます。
- REST APIでは、パスパラメータとしてリソースを指定する際にのみ使用できます。
- パスパラメータの例
-
/users/user0001
-
- パスパラメータの例