Retrieve a Function

GET /groups/{groupId}/apps/{appId}/functions/{functionId}

tokenAuth

Retrieve a Function.

path パラメータ

グループ ID string 必須

Atlas Project/Group ID。
appId string 必須

アプリケーションの ObjectID。App Services API プロジェクトとアプリケーション ID のセクションでは、この値を見つける方法が示されています。
functionId string 必須

関数のユニークな _id 値。

応答

200 application/ JSON

関数が正常に取得されました。
応答属性の非表示応答属性の表示オブジェクト
- _id string
- can_evaluate オブジェクト
  
  受信リクエストに応じて関数の実行が許可されている場合にtrueと評価される JSON 式。
- name string 必須
  
  関数のユニークな名前。
- private ブール値必須
  
  true の場合、関数はクライアントアプリケーションから非表示になります。受信 Webhook や Triggers などの JSON 式やその他の関数からプライベート関数を呼び出すこともできます。
- ソース string 必須
  
  関数の文字列化されたソースコード。コードは有効な ES6 である必要があります。
- run_as_system ブール値
  
  true の場合、関数はすべてのサービスに対するルールをバイパスして完全な権限で実行されます。
- run_as_user_id string
  
  アプリケーションユーザーのアカウントID。定義されている場合、エンドポイントは常に指定されたユーザーとして実行されます。run_as_user_id_script_source とは併用できません。
- run_as_user_id_script_source string
  
  アプリケーションユーザーのアカウントIDを返す関数の文字列化されたソースコード。定義されている場合、エンドポイントはリクエストごとに関数を実行し、関数から返されたIDを持つユーザーとして実行されます。run_as_user_id とは併用できません。

GET /groups/{groupId}/apps/{appId}/functions/{functionId}

curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/functions/{functionId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

応答の例（200）

{
  "_id": "string",
  "can_evaluate": {},
  "name": "string",
  "private": true,
  "source": "string",
  "run_as_system": true,
  "run_as_user_id": "string",
  "run_as_user_id_script_source": "string"
}