Folders

Folder related APIs

フォルダを作成

post

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

application/json

namestring · max: 50Required

parentFolderIdany ofOptional

stringOptional

or

nullOptional

followParentFolderPermissionany ofOptionalDefault: false

booleanOptional

or

nullOptional

permissionGroupEditorsany ofOptional

or

nullOptional

permissionGroupViewersany ofOptional

or

nullOptional

agentEditorsany ofOptional

string[]Optional

or

nullOptional

agentViewersany ofOptional

string[]Optional

or

nullOptional

userViewersany ofOptional

or

nullOptional

allowOtherAgentsViewbooleanOptionalDefault: true

allowOtherUsersViewbooleanOptionalDefault: true

Responses

200

正常に作成されました。

application/json

post

/webapi/v2/folders

HTTPcURLJavaScriptPython

POST /webapi/v2/folders HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 302

{
  "name": "text",
  "parentFolderId": "text",
  "followParentFolderPermission": false,
  "permissionGroupEditors": [],
  "permissionGroupViewers": [],
  "agentEditors": [
    "text"
  ],
  "agentViewers": [
    "text"
  ],
  "userViewers": {
    "customerIds": [
      "text"
    ],
    "customerGroupIds": [
      "text"
    ]
  },
  "allowOtherAgentsView": true,
  "allowOtherUsersView": true
}

200

正常に作成されました。

{
  "id": "text",
  "name": "text",
  "createdAt": 1,
  "updatedAt": 1,
  "parentFolderId": "text",
  "folderSize": 1
}

Get Folder

get

Get a single folder by ID with folder size information.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

folder_idstringRequired

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses

200

OK

application/json

get

/webapi/v2/folders/{folder_id}

HTTPcURLJavaScriptPython

GET /webapi/v2/folders/{folder_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

OK

{
  "id": "text",
  "name": "text",
  "createdAt": 1,
  "updatedAt": 1,
  "parentFolderId": "text",
  "folderSize": 1
}

フォルダーを更新する

put

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

folder_idstringRequired

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

application/json

namestring · max: 50Required

permissionGroupEditorsany ofOptional

or

nullOptional

permissionGroupViewersany ofOptional

or

nullOptional

agentEditorsany ofOptional

string[]Optional

or

nullOptional

agentViewersany ofOptional

string[]Optional

or

nullOptional

userViewersany ofOptional

or

nullOptional

allowOtherAgentsViewany ofOptional

booleanOptional

or

nullOptional

allowOtherUsersViewany ofOptional

booleanOptional

or

nullOptional

Responses

200

正常に更新されました。

application/json

put

/webapi/v2/folders/{folder_id}

HTTPcURLJavaScriptPython

PUT /webapi/v2/folders/{folder_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 241

{
  "name": "text",
  "permissionGroupEditors": [],
  "permissionGroupViewers": [],
  "agentEditors": [
    "text"
  ],
  "agentViewers": [
    "text"
  ],
  "userViewers": {
    "customerIds": [
      "text"
    ],
    "customerGroupIds": [
      "text"
    ]
  },
  "allowOtherAgentsView": true,
  "allowOtherUsersView": true
}

200

正常に更新されました。

{
  "id": "text",
  "name": "text",
  "createdAt": 1,
  "updatedAt": 1,
  "parentFolderId": "text",
  "folderSize": 1
}