Page MenuHomeClusterLabs Projects
Conduit phame.blog.edit

phame.blog.edit

API Method: phame.blog.edit

Login Required: This method requires authentication. You must log in before you can make calls to it.
Summary
Create or edit blogs in Phame.
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.

KeyDescription
nameRetitle the blog.
subtitleChange the blog subtitle.
descriptionChange the blog description.
domainFullURIChange the blog full domain URI.
parentSiteChange the blog parent site name.
parentDomainChange the blog parent domain.
statusActive or archive the blog.
viewChange the view policy of the object.
editChange the edit policy of the object.
interactChange the interaction policy of the object.
projects.addAdd project tags.
projects.removeRemove project tags.
projects.setSet project tags, overwriting current value.
subscribers.addAdd subscribers.
subscribers.removeRemove subscribers.
subscribers.setSet subscribers, overwriting current value.
mfaSign this transaction group with MFA.

name

Retitle the blog.

KeyTypeDescription
typeconstname
valuestringNew blog title.

subtitle

Change the blog subtitle.

KeyTypeDescription
typeconstsubtitle
valuestringNew blog subtitle.

description

Change the blog description.

KeyTypeDescription
typeconstdescription
valuestringNew blog description.

domainFullURI

Change the blog full domain URI.

KeyTypeDescription
typeconstdomainFullURI
valuestringNew blog full domain URI.

parentSite

Change the blog parent site name.

KeyTypeDescription
typeconstparentSite
valuestringNew blog parent site name.

parentDomain

Change the blog parent domain.

KeyTypeDescription
typeconstparentDomain
valuestringNew blog parent domain.

status

Active or archive the blog.

KeyTypeDescription
typeconststatus
valuestringNew blog status constant.

view

Change the view policy of the object.

KeyTypeDescription
typeconstview
valuestringNew policy PHID or constant.

edit

Change the edit policy of the object.

KeyTypeDescription
typeconstedit
valuestringNew policy PHID or constant.

interact

Change the interaction policy of the object.

KeyTypeDescription
typeconstinteract
valuestringNew policy PHID or constant.

projects.add

Add project tags.

KeyTypeDescription
typeconstprojects.add
valuelist<project>List of PHIDs to add.

projects.remove

Remove project tags.

KeyTypeDescription
typeconstprojects.remove
valuelist<project>List of PHIDs to remove.

projects.set

Set project tags, overwriting current value.

KeyTypeDescription
typeconstprojects.set
valuelist<project>List of PHIDs to set.

subscribers.add

Add subscribers.

KeyTypeDescription
typeconstsubscribers.add
valuelist<user>List of PHIDs to add.

subscribers.remove

Remove subscribers.

KeyTypeDescription
typeconstsubscribers.remove
valuelist<user>List of PHIDs to remove.

subscribers.set

Set subscribers, overwriting current value.

KeyTypeDescription
typeconstsubscribers.set
valuelist<user>List of PHIDs to set.

mfa

Sign this transaction group with MFA.

KeyTypeDescription
typeconstmfa
valuebool

Call Method

Enter parameters using JSON. For instance, to enter a list, type: ["apple", "banana", "cherry"]

list<map<string, wild>>
optional id|phid|string

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://projects.clusterlabs.org/ --conduit-token <conduit-token> -- phame.blog.edit