專案

一般

個人檔案

動作
歷史

指南 » 開發者指南 » REST API »

專案成員資格

/projects/:project_id/memberships.:format

GET

回傳專案成員資格的分頁清單。 :project_id 可以是專案的數字 ID 或專案識別碼。

範例:

GET /projects/1/memberships.xml
GET /projects/redmine/memberships.xml

回應:

<?xml version="1.0" encoding="UTF-8"?>
<memberships type="array" limit="25" offset="0" total_count="3">
  <membership>
    <id>1</id>
    <project name="Redmine" id="1"/>
    <user name="David Robert" id="17"/>
    <roles type="array">
      <role name="Manager" id="1"/>
    </roles>
  </membership>
  <membership>
    <id>3</id>
    <project name="Redmine" id="1"/>
    <group name="Contributors" id="24"/>
    <roles type="array">
      <role name="Contributor" id="3"/>
    </roles>
  </membership>
  <membership>
    <id>4</id>
    <project name="Redmine" id="1"/>
    <user name="John Smith" id="27"/>
    <roles type="array">
      <role name="Developer" id="2" />
      <role name="Contributor" id="3" inherited="true" />
    </roles>
  </membership>
</memberships>
注意事項
  • 成員資格擁有者可以是使用者或群組（群組 API 已於 Redmine 2.1 中新增）
  • 在上述範例中，最後一個角色上的 inherited="true" 屬性表示此角色是從群組繼承的（例如，Jonh Smith 屬於貢獻者群組，而此群組已新增為專案成員）。在先刪除群組成員資格之前，無法刪除 John Smith 的成員資格。
  • 特定使用者的成員資格可以從 使用者 API 中取得。

POST

新增專案成員。

參數:

  • membership（必填）：成員資格屬性的雜湊，包含
    • user_id（必填）：使用者或群組的數字 ID
    • role_ids（必填）：角色數字 ID 的陣列

範例:

POST /projects/redmine/memberships.xml

<membership>
  <user_id>27</user_id>
  <role_ids type="array">
    <role_id>2</role_id>
  </role_ids>
</membership>

JSON

{
  "membership":
  {
    "user_id": 27,
    "role_ids": [ 2 ]
  }
}

回應:

  • 201 Created：成員資格已建立
  • 422 Unprocessable Entity：由於驗證失敗，因此未建立成員資格（回應主體包含錯誤訊息）

/memberships/:id.:format

GET

回傳指定 :id 的成員資格。

範例:

GET /memberships/1.xml

回應:

<?xml version="1.0" encoding="UTF-8"?>
<membership>
  <id>1</id>
  <project name="Redmine" id="1"/>
  <user name="David Robert" id="17"/>
  <roles type="array">
    <role name="Developer" id="2"/>
    <role name="Manager" id="1"/>
  </roles>
</membership>

PUT

更新指定 :id 的成員資格。只有角色可以更新，成員資格的專案和使用者皆為唯讀。

參數:

  • membership（必填）：成員資格屬性的雜湊，包含
    • role_ids（必填）：角色數字 ID 的陣列

範例:

PUT /memberships/2.xml

<membership>
  <role_ids type="array">
    <role_id>3</role_id>
    <role_id>4</role_id>
  </role_ids>
</membership>

回應:

  • 204 No Content：成員資格已更新
  • 422 Unprocessable Entity：由於驗證失敗，因此未更新成員資格（回應主體包含錯誤訊息）

DELETE

刪除成員資格。

無法刪除從群組成員資格繼承的成員資格。您必須刪除群組成員資格。

參數:

無

範例:

DELETE /memberships/2.xml

回應:

  • 200 OK：成員資格已刪除
  • 422 Unprocessable Entity：成員資格未刪除

由 Go MAEDA 更新於 將近 3 年前 · 8 個版本