Page MenuHomeWikiOasis
Conduit project.edit

project.edit

API Method: project.edit

Login Required: This method requires authentication. You must log in before you can make calls to it.
Summary
Apply transactions to create a new project or edit an existing one.
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
parentChoose a parent project to create a subproject beneath.
milestoneChoose a parent project to create a new milestone for.
spaceShift the object between spaces.
nameRename the project
descriptionShort project description.
iconChange the project icon.
colorChange the project tag color.
slugsChange project slugs.
members.addAdd members.
members.removeRemove members.
members.setSet members, overwriting the current value.
viewChange the view policy of the object.
editChange the edit policy of the object.
joinChange the join policy of the object.
subtypeChange the object subtype.
mfaSign this transaction group with MFA.

parent

Choose a parent project to create a subproject beneath.

KeyTypeDescription
typeconstparent
valuephidPHID of the parent project.

milestone

Choose a parent project to create a new milestone for.

KeyTypeDescription
typeconstmilestone
valuephidPHID of the parent project.

space

Shift the object between spaces.

KeyTypeDescription
typeconstspace
valuephidNew space PHID.

name

Rename the project

KeyTypeDescription
typeconstname
valuestringNew project name.

description

Short project description.

KeyTypeDescription
typeconstdescription
valuestring

icon

Change the project icon.

KeyTypeDescription
typeconsticon
valuestringNew project icon.

color

Change the project tag color.

KeyTypeDescription
typeconstcolor
valuestringNew project tag color.

slugs

Change project slugs.

KeyTypeDescription
typeconstslugs
valuelist<string>New list of slugs.

members.add

Add members.

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

members.remove

Remove members.

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

members.set

Set members, overwriting the current value.

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

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.

join

Change the join policy of the object.

KeyTypeDescription
typeconstjoin
valuestringNew policy PHID or constant.

subtype

Change the object subtype.

KeyTypeDescription
typeconstsubtype
valuestringNew object subtype key.

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://phorge.wikioasis.org/ --conduit-token <conduit-token> -- project.edit