This is a standard ApplicationEditor method which allows you to create and modify objects by applying transactions. For documentation on these endpoints, see Conduit API: Using Edit Endpoints.
Conduit dashboard.panel.edit
dashboard.panel.edit
dashboard.panel.edit
API Method: dashboard.panel.edit
API Method: dashboard.panel.edit
Login Required: This method requires authentication. You must log in before you can make calls to it.
- Summary
- Apply transactions to create a new dashboard panel or edit an existing one.
- Returns
- map<string, wild>
- Errors
- ERR-CONDUIT-CORE: See error message for details.
- OAuth Scope
- OAuth clients may never call this method.
Method Description
Method Description
Transaction Summary
Transaction Summary
This endpoint supports these types of transactions. See below for detailed information about each transaction type.
| Key | Description |
|---|---|
| name | Rename the panel. |
| text | |
| view | Change the view policy of the object. |
| edit | Change the edit policy of the object. |
| mfa | Sign this transaction group with MFA. |
name
name
Rename the panel.
| Key | Type | Description |
|---|---|---|
| type | const | name |
| value | string | New panel name. |
text
text
| Key | Type | Description |
|---|---|---|
| type | const | text |
| value | string |
view
view
Change the view policy of the object.
| Key | Type | Description |
|---|---|---|
| type | const | view |
| value | string | New policy PHID or constant. |
edit
edit
Change the edit policy of the object.
| Key | Type | Description |
|---|---|---|
| type | const | edit |
| value | string | New policy PHID or constant. |
mfa
mfa
Sign this transaction group with MFA.
| Key | Type | Description |
|---|---|---|
| type | const | mfa |
| value | bool |
Call Method
Call Method
Examples
Examples
- Use the Conduit API Tokens panel in Settings to generate or manage API tokens.
- If you submit parameters, these examples will update to show exactly how to encode the parameters you submit.
$ echo <json-parameters> | arc call-conduit --conduit-uri https://scm.opengress.net/ --conduit-token <conduit-token> -- dashboard.panel.edit
$ curl https://scm.opengress.net/api/dashboard.panel.edit \
-d api.token=api-token \
-d param=value \
...
-d api.token=api-token \
-d param=value \
...
<?php
require_once 'path/to/arcanist/support/init/init-script.php';
$api_token = "<api-token>";
$api_parameters = array(<parameters>);
$client = new ConduitClient('https://scm.opengress.net/');
$client->setConduitToken($api_token);
$result = $client->callMethodSynchronous('dashboard.panel.edit', $api_parameters);
print_r($result);