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 harbormaster.buildplan.edit
harbormaster.buildplan.edit
harbormaster.buildplan.edit
API Method: harbormaster.buildplan.edit
API Method: harbormaster.buildplan.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 | Rename the plan. |
| behavior.hold-drafts | |
| behavior.arc-land | |
| behavior.buildable | |
| behavior.restartable | |
| behavior.runnable | |
| 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. |
| subscribers.add | Add subscribers. |
| subscribers.remove | Remove subscribers. |
| subscribers.set | Set subscribers, overwriting current value. |
| mfa | Sign this transaction group with MFA. |
Transaction Type: name
Transaction Type: name
Rename the plan.
| Key | Type | Description |
|---|---|---|
| type | const | name |
| value | string | New plan name. |
Transaction Type: behavior.hold-drafts
Transaction Type: behavior.hold-drafts
| Key | Type | Description |
|---|---|---|
| type | const | behavior.hold-drafts |
| value | string |
Transaction Type: behavior.arc-land
Transaction Type: behavior.arc-land
| Key | Type | Description |
|---|---|---|
| type | const | behavior.arc-land |
| value | string |
Transaction Type: behavior.buildable
Transaction Type: behavior.buildable
| Key | Type | Description |
|---|---|---|
| type | const | behavior.buildable |
| value | string |
Transaction Type: behavior.restartable
Transaction Type: behavior.restartable
| Key | Type | Description |
|---|---|---|
| type | const | behavior.restartable |
| value | string |
Transaction Type: behavior.runnable
Transaction Type: behavior.runnable
| Key | Type | Description |
|---|---|---|
| type | const | behavior.runnable |
| 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: subscribers.add
Transaction Type: subscribers.add
Add subscribers.
| Key | Type | Description |
|---|---|---|
| type | const | subscribers.add |
| value | list<user> | List of PHIDs to add. |
Transaction Type: subscribers.remove
Transaction Type: subscribers.remove
Remove subscribers.
| Key | Type | Description |
|---|---|---|
| type | const | subscribers.remove |
| value | list<user> | List of PHIDs to remove. |
Transaction Type: subscribers.set
Transaction Type: subscribers.set
Set subscribers, overwriting current value.
| Key | Type | Description |
|---|---|---|
| type | const | subscribers.set |
| value | list<user> | List of PHIDs to set. |
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 http://qa.in-portal.org/ --conduit-token <conduit-token> harbormaster.buildplan.edit
$ curl http://qa.in-portal.org/api/harbormaster.buildplan.edit \
-d api.token=api-token \
-d param=value \
...
-d api.token=api-token \
-d param=value \
...
<?php
require_once 'path/to/libphutil/src/__phutil_library_init__.php';
$api_token = "<api-token>";
$api_parameters = array(<parameters>);
$client = new ConduitClient('http://qa.in-portal.org/');
$client->setConduitToken($api_token);
$result = $client->callMethodSynchronous('harbormaster.buildplan.edit', $api_parameters);
print_r($result);