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 almanac.device.edit
almanac.device.edit
almanac.device.edit
API Method: almanac.device.edit
API Method: almanac.device.edit
Login Required: This method requires authentication. You must log in before you can make calls to it.
- Returns
- map<string, wild>
- Errors
- ERR-CONDUIT-CORE: See error message for details.
- OAuth Scope
- OAuth clients may never call this method.
Description
Transaction Types
Transaction Types
This endpoint supports these types of transactions. See below for detailed information about each transaction type.
| Key | Description |
|---|---|
| name | Name of the device. |
| status | Device status. |
| view | Change the view policy of the object. |
| edit | Change the edit policy of the object. |
| projects.add | Add project tags. |
| projects.remove | Remove project tags. |
| projects.set | Set project tags, overwriting current value. |
| property.set | Pass a map of values to set one or more properties. |
| property.delete | Pass a list of property names to delete properties. |
| mfa | Sign this transaction group with MFA. |
Transaction Type: name
Transaction Type: name
Name of the device.
| Key | Type | Description |
|---|---|---|
| type | const | name |
| value | string |
Transaction Type: status
Transaction Type: status
Device status.
| Key | Type | Description |
|---|---|---|
| type | const | status |
| value | string |
Transaction Type: view
Transaction Type: view
Change the view policy of the object.
| Key | Type | Description |
|---|---|---|
| type | const | view |
| value | string | New policy PHID or constant. |
Transaction Type: edit
Transaction Type: edit
Change the edit policy of the object.
| Key | Type | Description |
|---|---|---|
| type | const | edit |
| value | string | New policy PHID or constant. |
Transaction Type: projects.add
Transaction Type: projects.add
Add project tags.
| Key | Type | Description |
|---|---|---|
| type | const | projects.add |
| value | list<project> | List of PHIDs to add. |
Transaction Type: projects.remove
Transaction Type: projects.remove
Remove project tags.
| Key | Type | Description |
|---|---|---|
| type | const | projects.remove |
| value | list<project> | List of PHIDs to remove. |
Transaction Type: projects.set
Transaction Type: projects.set
Set project tags, overwriting current value.
| Key | Type | Description |
|---|---|---|
| type | const | projects.set |
| value | list<project> | List of PHIDs to set. |
Transaction Type: property.set
Transaction Type: property.set
Pass a map of values to set one or more properties.
| Key | Type | Description |
|---|---|---|
| type | const | property.set |
| value | wild | Map of property names to values. |
Transaction Type: property.delete
Transaction Type: property.delete
Pass a list of property names to delete properties.
| Key | Type | Description |
|---|---|---|
| type | const | property.delete |
| value | list<string> | List of property names. |
Transaction Type: mfa
Transaction Type: 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://phabricator.vortexnetwork.me/ --conduit-token <conduit-token> -- almanac.device.edit
$ curl https://phabricator.vortexnetwork.me/api/almanac.device.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://phabricator.vortexnetwork.me/');
$client->setConduitToken($api_token);
$result = $client->callMethodSynchronous('almanac.device.edit', $api_parameters);
print_r($result);