Planfix API: project.get: Difference between revisions
From Planfix
No edit summary |
No edit summary |
||
Line 29: | Line 29: | ||
|- | |- | ||
|} | |} | ||
Response: | |||
<source lang="xml"> | |||
<?xml version="1.0" encoding="UTF-8"?> | |||
<response status="ok"> | |||
<project> | |||
<id></id> | |||
<title></title> | |||
<description></description> | |||
<owner> | |||
<id></id> | |||
<name></name> | |||
</owner> | |||
<client> | |||
<id></id> | |||
<name></name> | |||
</client> | |||
<group> | |||
<id></id> | |||
<name></name> | |||
</group> | |||
<parent> | |||
<id></id> | |||
</parent> | |||
<template> | |||
<id></id> | |||
</template> | |||
<status></status> | |||
<hidden></hidden> | |||
<hasEndDate></hasEndDate> | |||
<endDate></endDate> | |||
<beginDate></beginDate> | |||
<taskCount></taskCount> | |||
<isOverdued></isOverdued> | |||
<isCloseToDeadline></isCloseToDeadline> | |||
<workers> | |||
<users> | |||
<user> | |||
<id></id> | |||
<name></name> | |||
</user> | |||
<!-- ... --> | |||
</users> | |||
<groups> | |||
<group> | |||
<id></id> | |||
<name></name> | |||
</group> | |||
<!-- ... --> | |||
</groups> | |||
</workers> | |||
<members> | |||
<users> | |||
<user> | |||
<id></id> | |||
<name></name> | |||
</user> | |||
<!-- ... --> | |||
</users> | |||
<groups> | |||
<group> | |||
<id></id> | |||
<name></name> | |||
</group> | |||
<!-- ... --> | |||
</groups> | |||
</members> | |||
<auditors> | |||
<users> | |||
<user> | |||
<id></id> | |||
<name></name> | |||
</user> | |||
<!-- ... --> | |||
</users> | |||
</auditors> | |||
<customData> | |||
<customValue> | |||
<field> | |||
<id></id> | |||
<name></name> | |||
</field> | |||
<value></value> | |||
<text></text> | |||
</customValue> | |||
<customValue> | |||
<!-- ... --> | |||
</customValue> | |||
<!-- ... --> | |||
</customData> | |||
</project> | |||
</response> | |||
</source> | |||
{| class="wikitable" style="margin-top: 1em; width:100% " |
Revision as of 06:59, 3 August 2022
A function that gets information about a project. Request format:
<?xml version="1.0" encoding="UTF-8"?>
<request method="project.get">
<account></account>
<sid></sid>
<project>
<id></id>
<general></general>
</project>
<signature></signature>
</request>
Name | Type | Value | Notes |
---|---|---|---|
project.id | int | identifier of the given project | |
project.general | int | project number | used when there is no ID parameter id |
signature | string(32) | signature |
Response:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<project>
<id></id>
<title></title>
<description></description>
<owner>
<id></id>
<name></name>
</owner>
<client>
<id></id>
<name></name>
</client>
<group>
<id></id>
<name></name>
</group>
<parent>
<id></id>
</parent>
<template>
<id></id>
</template>
<status></status>
<hidden></hidden>
<hasEndDate></hasEndDate>
<endDate></endDate>
<beginDate></beginDate>
<taskCount></taskCount>
<isOverdued></isOverdued>
<isCloseToDeadline></isCloseToDeadline>
<workers>
<users>
<user>
<id></id>
<name></name>
</user>
<!-- ... -->
</users>
<groups>
<group>
<id></id>
<name></name>
</group>
<!-- ... -->
</groups>
</workers>
<members>
<users>
<user>
<id></id>
<name></name>
</user>
<!-- ... -->
</users>
<groups>
<group>
<id></id>
<name></name>
</group>
<!-- ... -->
</groups>
</members>
<auditors>
<users>
<user>
<id></id>
<name></name>
</user>
<!-- ... -->
</users>
</auditors>
<customData>
<customValue>
<field>
<id></id>
<name></name>
</field>
<value></value>
<text></text>
</customValue>
<customValue>
<!-- ... -->
</customValue>
<!-- ... -->
</customData>
</project>
</response>