Conduit almanac.service.edit

almanac.service.edit

API Method: almanac.service.edit

Returns

map<string, wild>

Errors

ERR-CONDUIT-CORE: See error message for details.

OAuth Scope

OAuth clients may never call this method.

Method Description

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.

Transaction Summary

This endpoint supports these types of transactions. See below for detailed information about each transaction type.

Key	Description
name	Name of the service.
type	Set the service type.
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.

name

Name of the service.

Key	Type	Description
type	const	name
value	string

type

Set the service type.

Key	Type	Description
type	const	type
value	string	Service type.

view

Change the view policy of the object.

Key	Type	Description
type	const	view
value	string	New policy PHID or constant.

edit

Change the edit policy of the object.

Key	Type	Description
type	const	edit
value	string	New policy PHID or constant.

projects.add

Add project tags.

Key	Type	Description
type	const	projects.add
value	list<project>	List of PHIDs to add.

projects.remove

Remove project tags.

Key	Type	Description
type	const	projects.remove
value	list<project>	List of PHIDs to remove.

projects.set

Set project tags, overwriting current value.

Key	Type	Description
type	const	projects.set
value	list<project>	List of PHIDs to set.

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.

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.

mfa

Sign this transaction group with MFA.

Key	Type	Description
type	const	mfa
value	bool

Call Method

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://docs.sipthor.net/ --conduit-token <conduit-token> -- almanac.service.edit