Mengubah konfigurasi sumber data API tertentu.
Deskripsi operasi
When you modify a query statement, you can modify only the top-level JsonObject. You cannot modify parameters that are nested in multiple layers. For more information about the parameters, see Create an API data source.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
quickbi-public:ModifyApiDatasourceParameters |
update |
*All Resource
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| ApiId |
string |
Yes |
ID sumber data API. |
b66a66de51f24d149116c17718138194 |
| WorkspaceId |
string |
Yes |
ID ruang kerja. |
726bee5a-****-43e1-9a8e-b550f0120f35 |
| Parameters |
string |
Yes |
Konfigurasi parameter data API dalam format JSONArray. Anda dapat mengubah maksimal 10 parameter.
|
[{"name":"token","value":"xxxxxxxxxxxx"},{"name":"pageSize","value":100}] |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
The information returned. |
||
| RequestId |
string |
The request ID. |
D8749D65-E80A-433C-AF1B-CE9C180FF3B4 |
| Result |
boolean |
The execution result of the interface. Valid values:
|
true |
| Success |
boolean |
Indicates whether the request was successful. Valid values:
|
true |
Contoh
Respons sukses
JSONformat
{
"RequestId": "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
"Result": true,
"Success": true
}
Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | ApiDataSource.NotIn.Workspace | Target apiId not in target workspace. | |
| 400 | Workspace.NotIn.Organization | The workspace is not owned by the organization. | The workspace is not owned by the organization. |
| 400 | ApiDatasource.Not.Exist | Api datasource not exist. | |
| 400 | ApiDatasource.Param.IsNull | Api datasource modify parameters is null. | |
| 400 | ApiDatasource.Param.Oversize | The number of parameters of API data source exceeds the limit and cannot exceed %s. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.