Because CO Provisioning Targets are not useful without a corresponding Provisioning Plugin, and because Plugins do not currently support REST calls (CO-521), most of these operations are not actually implemented. The exception is the Provision request, which is implemented.
Add
Add a new CoProvisioningTarget.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| NewObjectResponse with | CoProvisioningTarget added |
|
| CoProvisioningTarget Request not provided in POST body |
| ErrorResponse with details in | An error in one or more provided fields |
|
| Authentication required |
|
| The specified CO does not exist |
|
| Unknown error |
Delete
Remove a CoProvisioningTarget.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
|
| CoProvisioningTarget deleted |
|
|
|
|
| Authentication required |
|
|
|
|
| Unknown error |
Edit
Edit an existing CoProvisioningTarget.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
|
| CoProvisioningTarget updated |
|
| CoProvisioningTarget Request not provided in POST body |
| ErrorResponse with details in | An error in one or more provided fields |
|
| Authentication required |
|
| The specified CO does not exist |
|
|
|
|
| Unknown error |
Provision
Request provisioning (or reprovisioning) of a CO Person.
Provisional API
This API call is likely to evolve to offer more flexibility. It may change across minor releases.
Request Format
Method |
|
|---|---|
URL |
|
Request Body | CoPerson Provisioning Request, CoGroup Provisioning Request, or CoEmailList Provisioning Request |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
|
| Provisioning request has been successfully processed |
|
| Provisioning request has been queued |
|
| Authentication required |
|
| CO Person not found |
|
| CO Group not found |
|
| CO Email List not found |
|
|
|
|
| Unknown error |
Not currently implementedView (all)
Retrieve all existing CoProvisioningTarget.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoProvisioningTarget returned | |
|
| Authentication required |
|
| Unknown error |
View (per CO)
Retrieve CoProvisioningTargets attached to a CO.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoProvisioningTargets returned | |
|
| Authentication required |
|
|
|
|
| Unknown error |
View (one)
Retrieve an existing CoProvisioningTarget.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoProvisioningTarget returned | |
|
| Authentication required |
|
|
|
|
| Unknown error |
Notes
- Response format requested is ignored where response is only via HTTP status, but must still be provided.
See Also
- cm_co_provisioning_targets data model definition