Planfix API action.get

Function for getting information about an action. Request format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="action.get">
  <account></account>
  <sid></sid>
  <action>
    <id></id>
  </action>
  <signature></signature>
</request>

Name	Type	Value	Notes
action.id	int	action identifier
signature	string(32)	signature

Response:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <action>
    <id></id>
    <description></description>
    <type></type>
    <statusChange>
      <oldStatus></oldStatus>
      <newStatus></newStatus>
    </statusChange>
    <isNotRead></isNotRead>
    <fromEmail></fromEmail>
    <dateTime></dateTime>
    <task>
      <id></id>
      <title></title>
    </task>
    <contact>
      <general></general>
      <name></name>
    </contact>
    <owner>
      <id></id>
      <name></name>
    </owner>
    <project>
      <id></id>
      <title></title>
    </project>
    <taskExpectDateChanged>
      <oldDate></oldDate>
      <newDate></newDate>
    </taskExpectDateChanged>
    <taskStartTimeChanged>
      <oldDate></oldDate>
      <newDate></newDate>
    </taskStartTimeChanged>
    <files>
      <file>
        <id></id>
        <name></name>
      </file>
      <file>
        <id></id>
        <name></name>
      </file>
      <!-- ... -->
    </files>
    <notifiedList>
      <user>
        <id></id>
        <name></name>
      </user>
      <user>
        <id></id>
        <name></name>
      </user>
      <!-- ... -->
    </notifiedList>
    <analitics>
      <analitic>
        <id></id>
        <key></key>
        <name></name>
      </analitic>
      <analitic>
        <id></id>
        <key></key>
        <name></name>
      </analitic>
      <!-- ... -->
    </analitics>
  </action>
</response>

Name	Type	Value	Notes
id	int	action identifier
description	string	action description
type	enum	type of action	for a list of possible actions, see the action types section
statusChange		the presence of this node indicates that this action has changed the status of the task
statusChange.oldStatus	enum	old status	for a list of valid values, see task statuses
statusChange.newStatus	enum	new status	for a list of valid values, see task statuses
isNotRead	bool	action not marked as read
fromEmail	bool	action created from an email
dateTime	DateTime	date the action was added
task		information about the task
task.id	int	task identifier
task.title	string	task name
contact		information about the contact	only present if the action was added to a contact
contact.general	int	contact's phone number
contact.name	string	contact's name
owner		user who created the action
owner.id	int	user identifier
owner.name	string	user's name
project		the project in which the action was created
project.id	int	project identifier
project.title	string	project name
taskExpectDateChanged		if this node is set, the action changed the task start time
taskExpectDateChanged.oldDate	DateTime	old time
taskExpectDateChanged.newDate	DateTime	new time
taskStartTimeChanged		if this node is set, the action changed the task start time
taskStartTimeChanged.oldDate	DateTime	old time
taskStartTimeChanged.newDate	DateTime	new time
files		list of files attached by this action
files.file		node describing a file
files.file.id	int	file identifier
files.file.name	string	file name
notifiedList		list of users who should be notified about the action
notifiedList.user		user
notifiedList.user.id	int	user identifier
notifiedList.user.name	string	user's name
datatags		list of data tags attached to the action
datatags.datatag		data tag
datatags.datatag.id	int	data tag identifier
datatags.datatag.key	int	data tag data row identifier
datatags.datatag.name	string	data tag name

Otherwise, an error response will be returned:

<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>

Go To

• Planfix API:Actions
• Error codes
• List of functions