Seminar Sales Partners Contact us Login Free Trial Document DownloadDocument

グループ

グループ

グループ検索

GET /api/v1/groups HTTP/1.1

Request

パラメータ 内容 必須 デフォルト値 最大値
name 検索するグループ名を設定 20文字
user_code 検索するユーザーコードを設定
page ページ 1
per_page ページ毎の取得数 20 100

パラメータ値例

{
  "name": "グループ",
  "user_code": "0000000001",
  "page": 1,
  "per_page": 50
}

cURLでのリクエスト例

curl 'https://{チームドメイン}.notepm.jp/api/v1/groups?name=グループ&user_code=0000000001&page=1&per_page=50' \
-H 'Authorization: Bearer {アクセストークン}'

Response

HTTP/1.1 200 OK
{
  groups: [ /*nameの昇順*/
    {
      "name": "グループA"
    },
    {
      "name": "グループB"
    }
  ],
  meta: {
    "previous_page": null,
    "next_page": "https://projectmode.notepm.jp/api/v1/groups?page=2&per_page=50",
    "page": 1,
    "per_page": 50,
    "total": 500
  }
}

グループ作成

POST /api/v1/groups HTTP/1.1

Request

パラメータ 内容 必須 デフォルト値 最大値
name グループ名を設定 ○

パラメータ値例

{
  "name": "グループA"
}

cURLでのリクエスト例

curl -X POST 'https://{チームドメイン}.notepm.jp/api/v1/groups' \
-H 'Authorization: Bearer {アクセストークン}' \
-H 'Content-Type: application/json' \
-d '{
    "name": "グループA"
}'

Response

HTTP/1.1 201 Created
{
  "group": {
    "name": "グループA",
    "users": [
      {
        "user_code": "0000000001",
        "name": "Aさん",
        "is_admin": true
      }
    ]
  },
  "meta": {
  }
}

グループ詳細取得

GET /api/v1/groups/:group_name HTTP/1.1

Request

パラメータなし

cURLでのリクエスト例

curl 'https://{チームドメイン}.notepm.jp/api/v1/groups/{グループ名}' \
-H 'Authorization: Bearer {アクセストークン}'

Response

HTTP/1.1 200 OK
{
  "group": {
    "name": "グループA",
    "users": [
      {
        "user_code": "0000000001",
        "name": "Aさん",
        "is_admin": true
      },
      {
        "user_code": "0000000002",
        "name": "Bさん",
        "is_admin": false
      }
    ]
  },
  "meta": {
  }
}

グループ削除

DELETE /api/v1/groups/:group_name  HTTP/1.1

Request

パラメータなし

cURLでのリクエスト例

curl -X DELETE 'https://{チームドメイン}.notepm.jp/api/v1/groups/{グループ名}' \
-H 'Authorization: Bearer {アクセストークン}'

Response

HTTP/1.1 204 No Content

グループにユーザー追加

POST /api/v1/groups/:group_name/users HTTP/1.1

Request

パラメータ 内容 必須 デフォルト値 最大値
users 追加するユーザーを配列で設定する

パラメータ値例

{
  "users": [
    "0000000002",
    "0000000003"
  ]
}

cURLでのリクエスト例

curl -X POST 'https://{チームドメイン}.notepm.jp/api/v1/groups/{グループ名}/users' \
-H 'Authorization: Bearer {アクセストークン}' \
-H 'Content-Type: application/json' \
-d '{
    "users": [
        "0000000002",
        "0000000003"
    ]
}'

Response

HTTP/1.1 204 No Content

グループからユーザー削除

DELETE /api/v1/groups/:group_name/users HTTP/1.1

Request

パラメータ 内容 必須 デフォルト値 最大値
users 削除するユーザーを配列で設定する

パラメータ値例

{
  "users": [
    "0000000002",
    "0000000003"
  ]
}

cURLでのリクエスト例

curl -X DELETE 'https://{チームドメイン}.notepm.jp/api/v1/groups/{グループ名}/users' \
-H 'Authorization: Bearer {アクセストークン}' \
-H 'Content-Type: application/json' \
-d '{
    "users": [
        "0000000002",
        "0000000003"
    ]
}'

Response

HTTP/1.1 204 No Content
Trial Document