TeamResource
Copyright 2013 WANdisco.
The following resources are part of this group:
- /teams
- /teams/counts
- /teams/rules
- /teams/{id}
- /teams/rules/counts
- /teams/{team_id}/leaders
- /teams/{team_id}/members
- /teams/{team_id}/resources
- /teams/{team_id}/rules
- /teams/{team_id}/subteams
- /teams/rules/counts/all
- /teams/{team_id}/leaders/available
- /teams/{team_id}/leaders/{user_id}
- /teams/{team_id}/members/available
- /teams/{team_id}/members/counts
- /teams/{team_id}/members/delete
- /teams/{team_id}/members/new
- /teams/{team_id}/members/{user_id}
- /teams/{team_id}/resources/available
- /teams/{team_id}/resources/delete
- /teams/{team_id}/rules/counts
- /teams/{team_id}/rules/{rule_id}
- /teams/{team_id}/testConnection/{ldap_authority_id}
- /teams/{team_id}/rules/{rule_id}/members
- /teams/{team_id}/rules/{rule_id}/resourcepermissions
- /teams/{team_id}/rules/{rule_id}/members/available
- /teams/{team_id}/rules/{rule_id}/members/delete
- /teams/{team_id}/rules/{rule_id}/resourcepermissions/delete
/teams
Mount Point: /dcone/teams
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| queryEnforced | (no documentation provided) | query | false |
| pageSize | (no documentation provided) | query | 20 |
| pageNumber | (no documentation provided) | query | 1 |
| fieldList | (no documentation provided) | query | |
| sortAscending | (no documentation provided) | query | true |
| sortColumn | (no documentation provided) | query | name |
| searchKeyList | (no documentation provided) | query | |
| searchValueList | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
POST
Request Body
| element: | team |
| media types: | */* application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/teams/counts
Mount Point: /dcone/teams/counts
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| queryEnforced | (no documentation provided) | query | false |
| id | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/teams/rules
Mount Point: /dcone/teams/rules
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| queryEnforced | (no documentation provided) | query | false |
| pageSize | (no documentation provided) | query | 20 |
| pageNumber | (no documentation provided) | query | 1 |
| fieldList | (no documentation provided) | query | |
| sortAscending | (no documentation provided) | query | true |
| sortColumn | (no documentation provided) | query | ruleName |
| searchKeyList | (no documentation provided) | query | |
| searchValueList | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/teams/{id}
Mount Point: /dcone/teams/{id}
The following operations are supported on this resource:
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| id | (no documentation provided) | path | |
| queryEnforced | (no documentation provided) | query | false |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
PUT
Parameters
| name | description | type | default |
|---|---|---|---|
| id | (no documentation provided) | path |
Request Body
| element: | team |
| media types: | */* application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
DELETE
Parameters
| name | description | type | default |
|---|---|---|---|
| id | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/teams/rules/counts
Mount Point: /dcone/teams/rules/counts
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| queryEnforced | (no documentation provided) | query | false |
| id | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/teams/{team_id}/leaders
Mount Point: /dcone/teams/{team_id}/leaders
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| queryEnforced | (no documentation provided) | query | false |
| team_id | (no documentation provided) | path | |
| fieldList | (no documentation provided) | query | |
| sortAscending | (no documentation provided) | query | true |
| sortColumn | (no documentation provided) | query | ownerUser |
| searchKeyList | (no documentation provided) | query | |
| searchValueList | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/teams/{team_id}/members
Mount Point: /dcone/teams/{team_id}/members
POST
Parameters
| name | description | type | default |
|---|---|---|---|
| team_id | (no documentation provided) | path |
Request Body
| element: | ids |
| media types: | */* application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| queryEnforced | (no documentation provided) | query | false |
| team_id | (no documentation provided) | path | |
| pageSize | (no documentation provided) | query | 20 |
| pageNumber | (no documentation provided) | query | 1 |
| fieldList | (no documentation provided) | query | |
| sortAscending | (no documentation provided) | query | true |
| sortColumn | (no documentation provided) | query | username |
| searchKeyList | (no documentation provided) | query | |
| searchValueList | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/teams/{team_id}/resources
Mount Point: /dcone/teams/{team_id}/resources
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| queryEnforced | (no documentation provided) | query | false |
| team_id | (no documentation provided) | path | |
| pageSize | (no documentation provided) | query | 20 |
| pageNumber | (no documentation provided) | query | 1 |
| fieldList | (no documentation provided) | query | |
| sortAscending | (no documentation provided) | query | true |
| sortColumn | (no documentation provided) | query | repositoryName |
| searchKeyList | (no documentation provided) | query | |
| searchValueList | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
POST
Parameters
| name | description | type | default |
|---|---|---|---|
| team_id | (no documentation provided) | path |
Request Body
| element: | resource |
| media types: | */* application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/teams/{team_id}/rules
Mount Point: /dcone/teams/{team_id}/rules
POST
Parameters
| name | description | type | default |
|---|---|---|---|
| team_id | (no documentation provided) | path |
Request Body
| element: | rule |
| media types: | */* application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| queryEnforced | (no documentation provided) | query | false |
| team_id | (no documentation provided) | path | |
| pageSize | (no documentation provided) | query | 20 |
| pageNumber | (no documentation provided) | query | 1 |
| fieldList | (no documentation provided) | query | |
| sortAscending | (no documentation provided) | query | true |
| sortColumn | (no documentation provided) | query | ruleName |
| searchKeyList | (no documentation provided) | query | |
| searchValueList | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/teams/{team_id}/subteams
Mount Point: /dcone/teams/{team_id}/subteams
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| queryEnforced | (no documentation provided) | query | false |
| team_id | (no documentation provided) | path | |
| pageSize | (no documentation provided) | query | 20 |
| pageNumber | (no documentation provided) | query | 1 |
| fieldList | (no documentation provided) | query | |
| sortAscending | (no documentation provided) | query | true |
| sortColumn | (no documentation provided) | query | name |
| searchKeyList | (no documentation provided) | query | |
| searchValueList | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
POST
Parameters
| name | description | type | default |
|---|---|---|---|
| team_id | (no documentation provided) | path |
Request Body
| element: | team |
| media types: | */* application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/teams/rules/counts/all
Mount Point: /dcone/teams/rules/counts/all
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| queryEnforced | (no documentation provided) | query | false |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/teams/{team_id}/leaders/available
Mount Point: /dcone/teams/{team_id}/leaders/available
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| queryEnforced | (no documentation provided) | query | false |
| pageSize | (no documentation provided) | query | 20 |
| pageNumber | (no documentation provided) | query | 1 |
| team_id | (no documentation provided) | path | |
| fieldList | (no documentation provided) | query | |
| sortAscending | (no documentation provided) | query | true |
| sortColumn | (no documentation provided) | query | username |
| searchKeyList | (no documentation provided) | query | |
| searchValueList | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/teams/{team_id}/leaders/{user_id}
Mount Point: /dcone/teams/{team_id}/leaders/{user_id}
The following operations are supported on this resource:
POST
Parameters
| name | description | type | default |
|---|---|---|---|
| team_id | (no documentation provided) | path | |
| user_id | (no documentation provided) | path |
Request Body
| element: | teamadminpermission |
| media types: | */* application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| team_id | (no documentation provided) | path | |
| user_id | (no documentation provided) | path | |
| queryEnforced | (no documentation provided) | query | false |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
DELETE
Parameters
| name | description | type | default |
|---|---|---|---|
| team_id | (no documentation provided) | path | |
| user_id | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
PUT
Parameters
| name | description | type | default |
|---|---|---|---|
| team_id | (no documentation provided) | path | |
| user_id | (no documentation provided) | path |
Request Body
| element: | teamadminpermission |
| media types: | */* application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/teams/{team_id}/members/available
Mount Point: /dcone/teams/{team_id}/members/available
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| queryEnforced | (no documentation provided) | query | false |
| team_id | (no documentation provided) | path | |
| pageSize | (no documentation provided) | query | 20 |
| pageNumber | (no documentation provided) | query | 1 |
| fieldList | (no documentation provided) | query | |
| sortAscending | (no documentation provided) | query | true |
| sortColumn | (no documentation provided) | query | id |
| searchKeyList | (no documentation provided) | query | |
| searchValueList | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/teams/{team_id}/members/counts
Mount Point: /dcone/teams/{team_id}/members/counts
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| queryEnforced | (no documentation provided) | query | false |
| team_id | (no documentation provided) | path | |
| id | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/teams/{team_id}/members/delete
Mount Point: /dcone/teams/{team_id}/members/delete
POST
Parameters
| name | description | type | default |
|---|---|---|---|
| team_id | (no documentation provided) | path |
Request Body
| element: | ids |
| media types: | */* application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/teams/{team_id}/members/new
Mount Point: /dcone/teams/{team_id}/members/new
POST
Creates a user and adds that user to a specific team.
Note, this operation is permitted for system admins and team leaders only.Standard non-team leader users are not authorized to use perform this operation.
Parameters
| name | description | type | default |
|---|---|---|---|
| team_id | the id of team to which the newly created user will be added to. | path |
Request Body
| element: | user |
| media types: | */* application/xml |
the user to create
Response Body
| element: | (custom) |
| media types: | */* application/xml |
| HTTP Response Code | When |
|---|---|
| 202 ACCEPTED | The request was accepted for processing. The DCone task id will also be returned in this case so the completion of the request (i.e. the creation of a user and the addition of that newly created user to a team) can be checked for success or failure. |
| 403 FORBIDDEN | If a standard non-team leader user is attempting to perform this operation, or the user performing this operation is a team leader, but not of the team specified in the request. |
| 400 BAD REQUEST | If the user represented by the userDTO argument already exists. |
| 400 BAD REQUEST | If the user represented by the userDTO is a local user and local users are disallowed by the application. |
| 400 BAD REQUEST | If no team exists matching the teamId argument. |
| 400 BAD REQUEST | If the user being created and added to the team needs to be added to one or more parent team(s) they are not already members of, but the user making the request does not have the appropriate permissions to add them to one or more parent team(s). |
| 500 INTERNAL SERVER ERROR | If some unexpected problem occurred during processing of the request. |
/teams/{team_id}/members/{user_id}
Mount Point: /dcone/teams/{team_id}/members/{user_id}
POST
Parameters
| name | description | type | default |
|---|---|---|---|
| team_id | (no documentation provided) | path | |
| user_id | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
DELETE
Parameters
| name | description | type | default |
|---|---|---|---|
| team_id | (no documentation provided) | path | |
| user_id | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/teams/{team_id}/resources/available
Mount Point: /dcone/teams/{team_id}/resources/available
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| queryEnforced | (no documentation provided) | query | false |
| team_id | (no documentation provided) | path | |
| pageSize | (no documentation provided) | query | 20 |
| pageNumber | (no documentation provided) | query | 1 |
| fieldList | (no documentation provided) | query | |
| sortAscending | (no documentation provided) | query | true |
| sortColumn | (no documentation provided) | query | repositoryName |
| searchKeyList | (no documentation provided) | query | |
| searchValueList | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/teams/{team_id}/resources/delete
Mount Point: /dcone/teams/{team_id}/resources/delete
POST
Parameters
| name | description | type | default |
|---|---|---|---|
| team_id | (no documentation provided) | path |
Request Body
| element: | ids |
| media types: | */* application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/teams/{team_id}/rules/counts
Mount Point: /dcone/teams/{team_id}/rules/counts
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| queryEnforced | (no documentation provided) | query | false |
| team_id | (no documentation provided) | path | |
| id | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/teams/{team_id}/rules/{rule_id}
Mount Point: /dcone/teams/{team_id}/rules/{rule_id}
The following operations are supported on this resource:
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| queryEnforced | (no documentation provided) | query | false |
| team_id | (no documentation provided) | path | |
| rule_id | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
DELETE
Parameters
| name | description | type | default |
|---|---|---|---|
| team_id | (no documentation provided) | path | |
| rule_id | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
PUT
Parameters
| name | description | type | default |
|---|---|---|---|
| team_id | (no documentation provided) | path | |
| rule_id | (no documentation provided) | path |
Request Body
| element: | rule |
| media types: | */* application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/teams/{team_id}/testConnection/{ldap_authority_id}
Mount Point: /dcone/teams/{team_id}/testConnection/{ldap_authority_id}
POST
Test an ldap connection for this team
Parameters
| name | description | type | default |
|---|---|---|---|
| team_id | (no documentation provided) | path | |
| ldap_authority_id | (no documentation provided) | path | |
| pageSize | (no documentation provided) | query | 20 |
| filter | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/teams/{team_id}/rules/{rule_id}/members
Mount Point: /dcone/teams/{team_id}/rules/{rule_id}/members
POST
Parameters
| name | description | type | default |
|---|---|---|---|
| team_id | (no documentation provided) | path | |
| rule_id | (no documentation provided) | path |
Request Body
| element: | ids |
| media types: | */* application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| queryEnforced | (no documentation provided) | query | false |
| team_id | (no documentation provided) | path | |
| rule_id | (no documentation provided) | path | |
| pageSize | (no documentation provided) | query | 20 |
| pageNumber | (no documentation provided) | query | 1 |
| fieldList | (no documentation provided) | query | |
| sortAscending | (no documentation provided) | query | true |
| sortColumn | (no documentation provided) | query | username |
| searchKeyList | (no documentation provided) | query | |
| searchValueList | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/teams/{team_id}/rules/{rule_id}/resourcepermissions
Mount Point: /dcone/teams/{team_id}/rules/{rule_id}/resourcepermissions
The following operations are supported on this resource:
POST
Parameters
| name | description | type | default |
|---|---|---|---|
| team_id | (no documentation provided) | path | |
| rule_id | (no documentation provided) | path |
Request Body
| element: | dtolist |
| media types: | */* application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| queryEnforced | (no documentation provided) | query | false |
| team_id | (no documentation provided) | path | |
| rule_id | (no documentation provided) | path | |
| pageSize | (no documentation provided) | query | 20 |
| pageNumber | (no documentation provided) | query | 1 |
| fieldList | (no documentation provided) | query | |
| sortAscending | (no documentation provided) | query | true |
| sortColumn | (no documentation provided) | query | path |
| searchKeyList | (no documentation provided) | query | |
| searchValueList | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
PUT
Parameters
| name | description | type | default |
|---|---|---|---|
| team_id | (no documentation provided) | path | |
| rule_id | (no documentation provided) | path |
Request Body
| element: | dtolist |
| media types: | */* application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/teams/{team_id}/rules/{rule_id}/members/available
Mount Point: /dcone/teams/{team_id}/rules/{rule_id}/members/available
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| queryEnforced | (no documentation provided) | query | false |
| team_id | (no documentation provided) | path | |
| rule_id | (no documentation provided) | path | |
| pageSize | (no documentation provided) | query | 20 |
| pageNumber | (no documentation provided) | query | 1 |
| fieldList | (no documentation provided) | query | |
| sortAscending | (no documentation provided) | query | true |
| sortColumn | (no documentation provided) | query | username |
| searchKeyList | (no documentation provided) | query | |
| searchValueList | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/teams/{team_id}/rules/{rule_id}/members/delete
Mount Point: /dcone/teams/{team_id}/rules/{rule_id}/members/delete
POST
Parameters
| name | description | type | default |
|---|---|---|---|
| team_id | (no documentation provided) | path | |
| rule_id | (no documentation provided) | path |
Request Body
| element: | ids |
| media types: | */* application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/teams/{team_id}/rules/{rule_id}/resourcepermissions/delete
Mount Point: /dcone/teams/{team_id}/rules/{rule_id}/resourcepermissions/delete
POST
Parameters
| name | description | type | default |
|---|---|---|---|
| team_id | (no documentation provided) | path | |
| rule_id | (no documentation provided) | path |
Request Body
| element: | ids |
| media types: | */* application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)