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.binding.edit
almanac.binding.edit
almanac.binding.edit
API Method: almanac.binding.edit
API Method: almanac.binding.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 |
|---|---|
| service | Select the service to bind. |
| interface | Set the interface to bind. |
| disabled | Disable or enable the binding. |
| 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: service
Transaction Type: service
Select the service to bind.
| Key | Type | Description |
|---|---|---|
| type | const | service |
| value | string | Service PHID. |
Transaction Type: interface
Transaction Type: interface
Set the interface to bind.
| Key | Type | Description |
|---|---|---|
| type | const | interface |
| value | string | Interface PHID. |
Transaction Type: disabled
Transaction Type: disabled
Disable or enable the binding.
| Key | Type | Description |
|---|---|---|
| type | const | disabled |
| value | bool | True to disable the binding. |
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://arendus.eenet.ee/ --conduit-token <conduit-token> almanac.binding.edit
$ curl https://arendus.eenet.ee/api/almanac.binding.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('https://arendus.eenet.ee/');
$client->setConduitToken($api_token);
$result = $client->callMethodSynchronous('almanac.binding.edit', $api_parameters);
print_r($result);