Получение информации о проекте

Эта страница только для чтения. Вы можете посмотреть её исходный текст, но не можете его изменить. Сообщите администратору, если считаете, что это неправильно.
====== Получение информации о проекте ======
Метод: **GetProject**

=====Передаваемые параметры=====
^Параметр^Описание^
|ASPNETSessionId|Идентификатор сессии|
|projectId|Идентификатор проекта|

<code xml>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetProject xmlns="http://streamline/">
      <contract>
        <ASPNETSessionId>string</ASPNETSessionId>
        <ProjectId>string</ProjectId>
      </contract>
    </GetProject>
  </soap:Body>
</soap:Envelope>
</code>

=====Возвращаемые параметры=====
^Параметр^Описание^
|UID|Идентификатор проекта|
|ParentProjectId|Идентификатор родительского проекта|
|Name|Название проекта|
|Status|Статус проекта|
|PercentComplete|Процент выполнения|
|SystemStartDate|Расчетная дата начала проекта|
|SystemEndDate|Расчетная дата окончания проекта|
|PlannedStartDate|Планируемая дата начала проекта|
|PlannedEndDate|Планируемая дата окончания проекта|
|ActualStartDate|Дата начала проекта|
|ActualEndDate|Дата окончания проекта|
|OwnerId|Идентификатор руководителя проекта|
|ResponsibleId|Идентификатор исполнителя проекта|
|ResourceAssignments|Массив назначенных ресурсов|
|ResourceAssignmentWrapper|Массив параметров ресурса|
|PersonId|Идентификатор ресурса|
|Value|Значение ресурса|
|PlannedCost|''(с версии 3.29)'' Значение плановых трудозатрат \\ Если объект не имеет плановых трудозатрат, то в параметре ''PlannedCost'' возвращается значение null|
|CalculatedCost|''(с версии 3.29)'' Значение расчетных трудозатрат \\ Если объект не имеет расчетных трудозатрат, то в параметре ''CalculatedCost'' возвращается значение null|

Возможные статусы объектов (значения параметра "Status"):
  * "1" -- Не начат
  * "3" -- В работе
  * "6" -- Завершен
  * "7" -- Отменен
  * "8" -- Отложен
  * "9" -- На проверке
статусы с номерами 2, 4 и 5 устарели и больше не используются.

Формат дат вида: ''YYYY-MM-DD''
  * YYYY -- указатель года
  * MM -- указатель месяца
  * DD -- указатель дня
<code xml>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetProjectResponse xmlns="http://streamline/">
      <GetProjectResult>
        <UID>string</UID>
        <ParentProjectId>string</ParentProjectId>
        <Name>string</Name>
        <Status>int</Status>
        <PercentComplete>int</PercentComplete>
        <SystemStartDate>dateTime</SystemStartDate>
        <SystemEndDate>dateTime</SystemEndDate>
        <PlannedStartDate>dateTime</PlannedStartDate>
        <PlannedEndDate>dateTime</PlannedEndDate>
        <ActualStartDate>dateTime</ActualStartDate>
        <ActualEndDate>dateTime</ActualEndDate>
        <OwnerId>string</OwnerId>
        <ResponsibleId>string</ResponsibleId>
        <ResourceAssignments>
          <ResourceAssignmentWrapper>
            <PersonId>string</PersonId>
            <Value>double</Value>
          </ResourceAssignmentWrapper>
          <ResourceAssignmentWrapper>
            <PersonId>string</PersonId>
            <Value>double</Value>
          </ResourceAssignmentWrapper>
        </ResourceAssignments>
      </GetProjectResult>
    </GetProjectResponse>
  </soap:Body>
</soap:Envelope>
</code>

Пример запроса с передачей плановых трудозатрат (''доступно с версии 3.29'') - добавлены необязательные передаваемые параметры ''PlannedCost'' и ''CalculatedCost'':

<code xml>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetProjectResponse xmlns="http://streamline/">
      <GetProjectResult>
        <UID>string</UID>
        <ParentProjectId>string</ParentProjectId>
        <Name>string</Name>
        <ProjectTypeId>string</ProjectTypeId>
        <ProjectType>string</ProjectType>
        <Status>int</Status>
        <PercentComplete>int</PercentComplete>
        <SystemStartDate>dateTime</SystemStartDate>
        <SystemEndDate>dateTime</SystemEndDate>
        <PlannedStartDate>dateTime</PlannedStartDate>
        <PlannedEndDate>dateTime</PlannedEndDate>
        <ActualStartDate>dateTime</ActualStartDate>
        <ActualEndDate>dateTime</ActualEndDate>
        <Order>int</Order>
        <OwnerId>string</OwnerId>
        <ResponsibleId>string</ResponsibleId>
        <ResourceAssignments>
          <ResourceAssignmentWrapper>
            <PersonId>guid</PersonId>
            <Value>double</Value>
          </ResourceAssignmentWrapper>
          <ResourceAssignmentWrapper>
            <PersonId>guid</PersonId>
            <Value>double</Value>
          </ResourceAssignmentWrapper>
        </ResourceAssignments>
        <UsePlannedCost>boolean</UsePlannedCost>
        <PlannedCost>double</PlannedCost>
        <CalculatedCost>double</CalculatedCost>
        <PlannedDuration>double</PlannedDuration>
        <DurationUnit>string</DurationUnit>
        <StartDateConstraint>string</StartDateConstraint>
        <EndDateConstraint>string</EndDateConstraint>
        <CalendarId>guid</CalendarId>
      </GetProjectResult>
    </GetProjectResponse>
  </soap:Body>
</soap:Envelope>
</code>

===== Пример вызова метода =====
Вызов метода с помощью [[https://soapui.ru/|SoapUI]]:

1. В окне запроса в передаваемых параметрах указать идентификатор сессии (можно получить с помощью метода [[:product:api:list:authenticate|Authenticate]]) и идентификатор проекта:

<image shape="thumbnail">{{ :product:api:list:getproject1.png |}}</image>
\\
2. При корректно выполненном методе появится код 200 и возвращаемые параметры - в данном случае:
  * ''UID'';
  * ''ParentProjectId'';
  * ''Name'';
  * ''Status'';
  * ''PercentComplete'';
  * ''SystemStartDate'' и ''SystemEndDate'';
  * ''PlannedStartDate'' и ''PlannedEndDate'';
  * ''ActualStartDate'' и ''ActualEndDate'';
  * ''OwnerId'';
  * ''ResponsibleId'';
  * ''ResourceAssignments''.

<image shape="thumbnail">{{ :product:api:list:getproject2.png |}}</image>
\\
Готовый пример:
<image shape="thumbnail">{{ :product:api:list:getproject3.png |}}</image>