Skip to content

Latest commit

 

History

History
171 lines (139 loc) · 4.62 KB

groups.md

File metadata and controls

171 lines (139 loc) · 4.62 KB
Raw

Get All Project or Resource Groups

GET /projectgroup

This documentation page will cover Project Groups, but for resource groups just replace project with resoruce

e.g.

GET /resourcegroup

Server Response example below for 1 projectGroup returned within an array.

[{  _id: '53a168304cc0f1bb16a898ca',
    name: '788',
    projects: {["53a168304cc0f1bb16a898ca", "53a168304cc0f1bb16a898ca"]}
    metadata: '' 
}]
Property Type Description Required Sortable
_id string id of the group NO NO
name string Group name YES YES
projects Array Array of Project Id's in Group NO NO
metadata string Custom Field (255 Characters) NO YES
createdDate date Creation date NO YES
updatedDate date Last update date NO YES

Get Specific Project

Use the following command to get a specific project by id.

GET /projectgroup/12345678

Will return projectGroup with the id 12345678

A successful projectGroup will return a 200 Ok response status from the server.

Create a Group

Create a new projectGroup.

POST /projectgroup

An example of a projectGroup

{
	"name": "My Developer Group"
}

The server will return the full projectGroup object once created including the newly created projectGroup ID _id

A successful create will return a 201 Ok response status from the server.

Subgroup

If you have Sidebar Pro extension enabled on your account you can create a group as subgroup by specifying id of parent group. For example:

{
	"name": "My Developer Subgroup",
	"parentGroupId": "123456789"
}

This will create subgroup of group 123456789.

Update a projectGroup

Update an existing project.

PUT /projectgroup/123456789

will update the projectGroup with the id 123456789. You must pass in the entire projectGroup object in the body.

A successful update will return a 200 Ok response status from the server.

Subgroup

If you have Sidebar Pro extension enabled on your account you can use update endpoint to change parentGroupId of a group, converting it into subgroup or extracting subgroup into parent group. To convert subgroup into parent group pass null as the value.

Delete a projectGroup

Use the following command to delete a specific projectGroup by id.

DELETE /projectgroup/12345678

Will delete projectGroup with the id 12345678

A successful delete will return a 200 Ok response status from the server.

Add a Project to a ProjectGroup

Add a Project to a ProjectGroup

POST projectgroup/addProjectsToGroup/123456
Accept: application/json
Content-Type: application/json

{"projectIds":["654654365436543634","654365436543654365436"]}

A successful add will return a 200 Ok response status from the server.

Add a Resource to a ResourceGroup

Add a Resource to a ResourceGroup

POST resourcegroup/addResourcesToGroup/123456
Accept: application/json
Content-Type: application/json

{"resourceIds":["654654365436543634","654365436543654365436"]}

A successful add will return a 200 Ok response status from the server.

Remove a Project from a ProjectGroup

Remove a Project from a ProjectGroup

POST projectgroup/removeProjectFromGroups/123456
Accept: application/json
Content-Type: application/json

'{"groupIds":["654654365436543634","654365436543654365436"]}'

A successful add will return a 200 Ok response status from the server.

Remove a Resource from a ResourceGroup

Remove a Resource from a ResourceGroup

POST resourcegroup/removeResourceFromGroups/123456
Accept: application/json
Content-Type: application/json

{"groupIds":["654654365436543634","654365436543654365436"]}

A successful add will return a 200 Ok response status from the server.

Add approver to a ResourceGroup

Update your resource group and pass array of approvers.

PUT resourcegroup/:id
Accept: application/json
Content-Type: application/json

{
	...
	"approvers": ["654654365436543634","654365436543654365436"]
	...
}

A successful update will return a 200 Ok response status from the server, and an updated ResourceGroup.

Or use a dedicated endpoint to add approver to multiple groups

PUT resourcegroup/addApproverToGroups/:resourceId
Accept: application/json
Content-Type: application/json

{
	groupIds: ["654654365436543634","654365436543654365436"]
}

A successful call will return a 200 Ok response status

Remove approver from a ResourceGroup

PUT resourcegroup/removeApproverFromGroups/:resourceId
Accept: application/json
Content-Type: application/json

{
	groupIds: ["654654365436543634","654365436543654365436"]
}

A successful call will return a 200 Ok response status