Conduit maniphest.edit

maniphest.edit

API Method: maniphest.edit

Returns

map<string, wild>

Errors

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

OAuth Scope

OAuth clients may never call this 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 Types

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

Key	Description
parent	Create as a subtask of another task.
column	Move a task to one or more workboard columns.
space	Shift the object between spaces.
title	Rename the task.
owner	Reassign the task.
status	Change the task status.
priority	Change the priority of the task.
description	Update the task description.
parents.add	Change the parents of this task.
parents.remove	Change the parents of this task.
parents.set	Change the parents of this task.
subtasks.add	Change the subtasks of this task.
subtasks.remove	Change the subtasks of this task.
subtasks.set	Change the subtasks of this task.
commits.add	Change the related commits for this task.
commits.remove	Change the related commits for this task.
commits.set	Change the related commits for this task.
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.
subtype	Change the object subtype.
comment	Make comments.
mfa	Sign this transaction group with MFA.

Transaction Type: parent

Create as a subtask of another task.

Key	Type	Description
type	const	parent
value	phid	PHID of the parent task.

Transaction Type: column

Move a task to one or more workboard columns.

You can use this transaction type to create a task into a particular workboard column, or move an existing task between columns.

The transaction value can be specified in several forms. Some are simpler but less powerful, while others are more complex and more powerful.

The simplest valid value is a single column PHID:

"PHID-PCOL-1111"

This will move the task into that column, or create the task into that column if you are creating a new task. If the task is currently on the board, it will be moved out of any exclusive columns. If the task is not currently on the board, it will be added to the board.

You can also perform multiple moves at the same time by passing a list of PHIDs:

["PHID-PCOL-2222", "PHID-PCOL-3333"]

This is equivalent to performing each move individually.

The most complex and most powerful form uses a dictionary to provide additional information about the move, including an optional specific position within the column.

The target column should be identified as columnPHID, and you may select a position by passing either beforePHIDs or afterPHIDs, specifying the PHIDs of tasks currently in the column that you want to move this task before or after:

[
  {
    "columnPHID": "PHID-PCOL-4444",
    "beforePHIDs": ["PHID-TASK-5555"]
  }
]

When you specify multiple PHIDs, the task will be moved adjacent to the first valid PHID found in either of the lists. This allows positional moves to generally work as users expect even if the client view of the board has fallen out of date and some of the nearby tasks have moved elsewhere.

Key	Type	Description
type	const	column
value	list<phid>	List of columns to move the task to.

Transaction Type: space

Shift the object between spaces.

Key	Type	Description
type	const	space
value	phid	New space PHID.

Transaction Type: title

Rename the task.

Key	Type	Description
type	const	title
value	string	New task name.

Transaction Type: owner

Reassign the task.

Key	Type	Description
type	const	owner
value	phid\|null	New task owner, or `null` to unassign.

Transaction Type: status

Change the task status.

Key	Type	Description
type	const	status
value	string	New task status constant.

Transaction Type: priority

Change the priority of the task.

Key	Type	Description
type	const	priority
value	string	New task priority constant.

Transaction Type: description

Update the task description.

Key	Type	Description
type	const	description
value	string	New task description.

Transaction Type: parents.add

Change the parents of this task.

Key	Type	Description
type	const	parents.add
value	list<phid>	List of PHIDs to add.

Transaction Type: parents.remove

Change the parents of this task.

Key	Type	Description
type	const	parents.remove
value	list<phid>	List of PHIDs to remove.

Transaction Type: parents.set

Change the parents of this task.

Key	Type	Description
type	const	parents.set
value	list<phid>	List of PHIDs to set.

Transaction Type: subtasks.add

Change the subtasks of this task.

Key	Type	Description
type	const	subtasks.add
value	list<phid>	List of PHIDs to add.

Transaction Type: subtasks.remove

Change the subtasks of this task.

Key	Type	Description
type	const	subtasks.remove
value	list<phid>	List of PHIDs to remove.

Transaction Type: subtasks.set

Change the subtasks of this task.

Key	Type	Description
type	const	subtasks.set
value	list<phid>	List of PHIDs to set.

Transaction Type: commits.add

Change the related commits for this task.

Key	Type	Description
type	const	commits.add
value	list<phid>	List of PHIDs to add.

Transaction Type: commits.remove

Change the related commits for this task.

Key	Type	Description
type	const	commits.remove
value	list<phid>	List of PHIDs to remove.

Transaction Type: commits.set

Change the related commits for this task.

Key	Type	Description
type	const	commits.set
value	list<phid>	List of PHIDs to set.

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

Change the edit policy of the object.

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

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

Remove project tags.

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

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

Add subscribers.

Key	Type	Description
type	const	subscribers.add
value	list<user>	List of PHIDs to add.

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

Set subscribers, overwriting current value.

Key	Type	Description
type	const	subscribers.set
value	list<user>	List of PHIDs to set.

Transaction Type: subtype

Change the object subtype.

Key	Type	Description
type	const	subtype
value	string	New object subtype key.

Transaction Type: comment

Make comments.

Key	Type	Description
type	const	comment
value	string	Comment to add, formatted as remarkup.

Transaction Type: 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://stash.despawningbone.me/ --conduit-token <conduit-token> maniphest.edit