コンテンツにスキップ

一覧



GET /api/v1/notify_object/list

概要

名前で現在のワークスペースの通知先をページングしてクエリします。

呼び出し前の確認事項と使用手順

結果には有効なオブジェクトと無効なオブジェクトが含まれ、レコード id の降順で並びます。content.data を読み取り、最上位の pageInfo でページングします。後続の呼び出しでは各項目の uuid を使用し、データベースの id は使用しないでください。hasAutoDisabled は今回返却されたページのみを対象とし、ワークスペース全体の統計を表すものではありません。作成または変更後は、この API で設定が保存されたかどうかを確認できます。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得・入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Query リクエストパラメータ

パラメータ名 型 必須 説明
pageIndex integer ページ番号。最小値は 1、デフォルトは 1。
null 許可: False
$minValue: 1
例: 1
取得・入力方法: 先頭ページは 1 から順に増加します。
pageSize integer 1 ページあたりの件数。デフォルトは 100 で、例に示す 10 ではありません。
null 許可: False
$maxValue: 100
$minValue: 1
例: 10
取得・入力方法: 必要に応じて 1 から 100 の範囲で指定します。
search string 名前によるあいまい検索。省略した場合は絞り込みません。
null 許可: True
例: 生产
取得・入力方法: 通知先の名前のキーワードを指定します。

パラメータの補足説明

この公開 API は search、pageIndex、pageSize のみを宣言しています。共有内部 API の types、status、autoDisabled といったフィルタパラメータを直接渡さないでください。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/notify_object/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode 'search=生产' \
  --data-urlencode pageIndex=1 \
  --data-urlencode pageSize=10

レスポンス

HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。

フィールド 型 説明
content object リスト結果オブジェクト。
content.data array<object> 現在のページの通知先配列。結果がない場合は [] です。
content.data[].id integer データベース上の番号。後続の操作では uuid を使用してください。
content.data[].uuid string 通知先の UUID。
content.data[].workspaceUUID string 所属ワークスペースの UUID。
content.data[].name string 通知先の名前。
content.data[].type string 通知タイプ。旧 Jira/ServiceNow の保存エイリアスは jiraWebhook/serviceNowWebhook に正規化されます。
content.data[].optSet object type に対応する通知設定。具体的なフィールドは以下を参照してください。未設定のフィールドは省略される場合があります。
content.data[].openPermissionSet boolean このオブジェクトのカスタム操作権限が有効かどうか。
content.data[].permissionSet array<string> オブジェクトの操作を許可するロール、メンバー、チームの識別子の配列。
content.data[].permissionSet[] string 個々の権限主体の識別子。
content.data[].autoDisableAt integer 自動無効化の時刻(Unix 秒)。自動無効化されていない場合は -1。
content.data[].status integer レコードのステータス。0 は有効、2 は無効。3(削除済み)はこのクエリでは返されません。
content.data[].creator string 作成者の識別情報。
content.data[].updator string 最終更新者の識別情報。未更新の場合は空。
content.data[].createAt integer 作成時刻(Unix 秒)。
content.data[].updateAt integer 更新時刻(Unix 秒)。未更新の場合は -1。
content.data[].deleteAt integer 削除時刻(Unix 秒)。未削除の場合は -1。
content.data[].optSet.webhook string ボット、Slack、Teams、Google Chat、Jira、ServiceNow が使用するコールバックアドレス。Jira/ServiceNow では有効な HTTPS である必要があり、URL のユーザー名・パスワード、フラグメント、空白を含めることはできません。アドレスはサイトのドメイン解決およびイントラネットポリシーの制限を受けます。
content.data[].optSet.secret string DingTalk/Lark などのボットでは元の署名キーが返される場合があります。Jira は元のキーを返さず、hasSecret フラグを使用します。
content.data[].optSet.url string HTTPRequest/simpleHTTPRequest の必須の非空コールバックアドレス。ドメイン解決およびイントラネットポリシーの制限を受けます。
content.data[].optSet.to array<string> mailGroup、sms、vms の受信メンバー/チーム UUID の配列。メンバーのプロファイルに対応するメールアドレスまたは携帯電話番号が設定されている必要があります。任意のメールアドレス/電話番号の文字列配列ではありません。
content.data[].optSet.to[] string 個々のメンバーまたはチームの UUID。
content.data[].optSet.refMembers array<string> HTTPRequest/simpleHTTPRequest はいずれも文字列配列を受け付けて検証しますが、現在実際に refMembersInfo へ展開されコンテンツ解析に使用されるのは HTTPRequest のみです。simpleHTTPRequest ではこの展開は行われません。
content.data[].optSet.refMembers[] string 関連するメンバーまたはチームの UUID 文字列。
content.data[].optSet.headersConfig object カスタムリクエストヘッダー設定。Jira/ServiceNow の headers とは異なります。読み取り API は機密値を復元して返すため、保存前に返却データを適切に扱ってください。
content.data[].optSet.headersConfig.isOpen boolean 設定が存在する場合は真偽値の指定が必須です。true の場合のみカスタムヘッダーを送信します。
content.data[].optSet.headersConfig.items array<object> 設定が存在する場合は配列の指定が必須で、最大 50 項目です。isOpen=false でも各項目は検証されます。
content.data[].optSet.headersConfig.items[] object 個々のカスタムリクエストヘッダーオブジェクト。
content.data[].optSet.headersConfig.items[].key string 非空の文字列。前後の空白を除いた後で最大 256 文字、大文字小文字を区別せずに重複排除されます。
content.data[].optSet.headersConfig.items[].value string 非空の文字列。最大 4096 文字。
content.data[].optSet.headersConfig.items[].isSensitive boolean 必須の真偽値。true の値は保存時に暗号化され、詳細と一覧では元の値が復元されます。
content.data[].optSet.bodyTemplate string HTTPRequest のみがカスタムリクエストボディテンプレートをサポートし、文字列は最大 5120 文字です。空文字列または null は未設定を意味し、空白のみの場合は有効になりません。保存時は型と長さのみを検証し、テンプレート構文や変数は検証しません。実際の送信はサイトのテンプレート機能に依存するため、実際のアラートで検証する必要があります。simpleHTTPRequest は非空のテンプレートをサポートしません。
content.data[].optSet.token string telegramBot は設定された Bot Token を返します。Jira/ServiceNow は bearer 認証情報を返さず、hasToken フラグを使用します。
content.data[].optSet.chat_id string telegramBot の必須の対象チャット ID 文字列。
content.data[].optSet.message_thread_id string telegramBot の任意のトピック ID。存在する場合は文字列。
content.data[].optSet.auth_type string または null Jira/ServiceNow のみ。null の場合は独立した認証ヘッダーを生成しません。basic、bearer、api_key のいずれもサポートされます。secret は Jira のみサポートされます。省略時は Jira が secret、ServiceNow が basic をデフォルトとします。
content.data[].optSet.username string Jira/ServiceNow の basic 認証ユーザー名。非空で、コロンや改行を含めることはできません。
content.data[].optSet.api_key_header string Jira/ServiceNow の api_key 認証ヘッダー名。Content-Type は指定できません。
content.data[].optSet.headers object Jira/ServiceNow のみ。ヘッダー名は有効で、大文字小文字を区別せず重複せず、値に改行を含まないことが条件です。Content-Type は application/json のみ指定できます。同じ識別情報での更新時に省略した場合は元のヘッダーが保持され、{} でクリアされます。読み取り時は値がマスクされ空文字列になります。
content.data[].optSet.headers.動的キー string カスタムヘッダーの文字列値。更新時に同名で空値を指定すると、同じ識別情報の旧値を保持できます。新規ヘッダーに空値は指定できません。
content.data[].optSet.hasSecret boolean Jira の secret モードのみ。署名キーが設定済みかどうか。
content.data[].optSet.hasPassword boolean Jira/ServiceNow の basic モードのみ。パスワードが設定済みかどうか。
content.data[].optSet.hasToken boolean Jira/ServiceNow の bearer モードのみ。Token が設定済みかどうか。
content.data[].optSet.hasApiKey boolean Jira/ServiceNow の api_key モードのみ。Key が設定済みかどうか。
content.data[].optSet.hasHeaderValues object Jira/ServiceNow のみ。返却される各ヘッダーについて、非空の値が保存済みかどうかを示します。
content.data[].optSet.hasHeaderValues.動的キー boolean ヘッダー名に対応する設定状態。
content.data[].optSet.deliveryStatus string Jira/ServiceNow の設定表示用の識別子。現在は configured であり、実際の配信成功を意味するものではありません。
content.data[].optSet.credentialsRequired boolean Jira/ServiceNow で、現在の認証方式に必要な認証情報またはヘッダー値がまだ不足しているかどうか。
content.data[].creatorInfo object または string 作成者のサマリー。情報がない場合、一覧では {}、詳細では空文字列になることがあります。
content.data[].creatorInfo.uuid string アカウントまたは API Key の UUID。
content.data[].creatorInfo.status integer アカウントのステータス。
content.data[].creatorInfo.wsAccountStatus integer ワークスペース内でのアカウントのステータス。
content.data[].creatorInfo.username string ユーザー名。
content.data[].creatorInfo.name string 表示名。
content.data[].creatorInfo.iconUrl string アバター URL。
content.data[].creatorInfo.email string メールアドレスまたは API Key の識別子。
content.data[].creatorInfo.mobile string 携帯電話番号。空の場合があります。
content.data[].creatorInfo.countryCode string 携帯電話番号の国番号。空の場合があります。
content.data[].creatorInfo.acntWsNickname string ワークスペースのニックネーム。空の場合があります。
content.data[].updatorInfo object または string 更新者のサマリー。情報がない場合、一覧では {}、詳細では空文字列になることがあります。詳細では現在作成者のみを照会するため、更新者の識別情報が異なる場合は情報が存在しないことがあります。
content.data[].updatorInfo.uuid string アカウントまたは API Key の UUID。
content.data[].updatorInfo.status integer アカウントのステータス。
content.data[].updatorInfo.wsAccountStatus integer ワークスペース内でのアカウントのステータス。
content.data[].updatorInfo.username string ユーザー名。
content.data[].updatorInfo.name string 表示名。
content.data[].updatorInfo.iconUrl string アバター URL。
content.data[].updatorInfo.email string メールアドレスまたは API Key の識別子。
content.data[].updatorInfo.mobile string 携帯電話番号。空の場合があります。
content.data[].updatorInfo.countryCode string 携帯電話番号の国番号。空の場合があります。
content.data[].updatorInfo.acntWsNickname string ワークスペースのニックネーム。空の場合があります。
content.data[].allow_operation boolean または null カスタム操作権限の計算結果。true は許可、false は拒否。null はオブジェクトのカスタム権限が有効でないことを示し、その場合も API 権限を満たす必要があります。
content.data[].permissionSetInfo object permissionSet の識別子をキーとする主体のサマリー。permissionSet が非空の場合にのみ出現します。
content.data[].permissionSetInfo.主体識別子 object メンバーの場合はアカウントのサマリー、チーム/ロールの場合は {name,status} です。無効な主体は空のオブジェクトになることがあります。
content.data[].permissionSetInfo.主体識別子.name string チームまたはロールの表示名。メンバーの場合、フィールドは creatorInfo と同じです。
content.data[].permissionSetInfo.主体識別子.status integer 主体のステータス。0 は正常。
content.data[].permissionSetInfo.主体識別子.uuid string アカウントまたは API Key の UUID。
content.data[].permissionSetInfo.主体識別子.wsAccountStatus integer ワークスペース内でのアカウントのステータス。
content.data[].permissionSetInfo.主体識別子.username string ユーザー名。
content.data[].permissionSetInfo.主体識別子.iconUrl string アバター URL。
content.data[].permissionSetInfo.主体識別子.email string メールアドレスまたは API Key の識別子。
content.data[].permissionSetInfo.主体識別子.mobile string 携帯電話番号。空の場合があります。
content.data[].permissionSetInfo.主体識別子.countryCode string 携帯電話番号の国番号。空の場合があります。
content.data[].permissionSetInfo.主体識別子.acntWsNickname string ワークスペースのニックネーム。空の場合があります。
content.data[].funcServerInfo object 過去のセルフホスト通知関数オブジェクトのみ返される場合があります。この公開作成 API ではこのタイプを作成できません。
content.data[].funcServerInfo.isActive boolean 関数サービスが稼働しているかどうか。
content.data[].funcServerInfo.lastPingAt integer 最終ハートビート時刻(Unix 秒)。ハートビートがない場合は -1。
content.data[].funcServerInfo.status integer 関数サービスのステータス。
content.hasAutoDisabled boolean 今回のページに autoDisableAt が -1 でないオブジェクトが存在するかどうか。
content.declaration object または null ワークスペースの共通宣言。
pageInfo object 最上位のページングオブジェクト。
pageInfo.pageIndex integer 現在のページ番号。
pageInfo.pageSize integer 1 ページあたりの件数。
pageInfo.count integer 現在のページの実際の件数。
pageInfo.totalCount integer 名前検索に一致する総数。
{
  "code": 200,
  "content": {
    "data": [
      {
        "id": 42,
        "uuid": "notify_example",
        "workspaceUUID": "wksp_example",
        "name": "生产回调",
        "type": "HTTPRequest",
        "optSet": {
          "url": "https://receiver.example.com/alerts"
        },
        "openPermissionSet": false,
        "permissionSet": [],
        "autoDisableAt": -1,
        "status": 0,
        "creator": "wsak_example",
        "updator": "",
        "createAt": 1785427200,
        "updateAt": -1,
        "deleteAt": -1,
        "creatorInfo": {},
        "updatorInfo": {},
        "allow_operation": null
      }
    ],
    "hasAutoDisabled": false,
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 10,
    "count": 1,
    "totalCount": 1
  }
}

エラー応答

認証、レート制限、共通リクエストのエラーについては共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたは応答の説明 対処方法
406 ft.ParameterValidationFailed 宣言されていない Query パラメータの使用、またはパラメータがルールに違反している場合 パラメータ解析に失敗 Query パラメータ表および例を確認してください。
500 ft.InternalServerError 設定フィールドの欠落や型の不正、データベースまたはキャッシュの処理失敗 内部エラー 本ページに従って該当する通知タイプの設定を確認し、traceId を記録してください。書き込み操作が失敗した場合は、まず対象が保存済みかどうかを照会してから再試行してください。

フィードバック

このページは役に立ちましたか?