Requires ModuleWhat's this?
This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.
This feature may not be available on all Jive instances.
Stage
Stage Service
Web service endpoints for idea stages.
Availability:
Available only when the Ideation plugin is installed in this Jive instance
Since: 3.1
Requires ModuleWhat's this?
This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.
This feature may not be available on all Jive instances.
Create Stage
POST /stagesCreate a new idea stage with the specified characteristics for this Jive instance, and return an entity representing the newly created stage.
Query Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| fields | String | false | The fields to include in the returned entity |
Takes:
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 400 (Bad Request) | If any input field is malformed |
| 409 (Conflict) | If there is an existing stage with the specified name |
| 403 (Forbidden) | If you are not allowed to create new idea stages |
| 410 (Gone) | If this Jive instance is not licensed for the Ideation module |
Requires ModuleWhat's this?
This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.
This feature may not be available on all Jive instances.
Destroy Stage
DELETE /stages/{stageID}Delete the specified idea stage from this Jive instance.
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| stageID | String | true | The ID of the idea stage to be deleted |
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 400 (Bad Request) | If any input field is malformed |
| 403 (Forbidden) | If you are not allowed to delete this idea stage |
| 410 (Gone) | If this Jive instance is not licensed for the Ideation module |
| 404 (Not Found) | If the specified idea stage does not exist |
Requires ModuleWhat's this?
This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.
This feature may not be available on all Jive instances.
Get Stage
GET /stages/{stageID}Return the specified idea stage with the specified fields.
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| stageID | String | true | The ID of the idea stage to be returned |
Query Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| fields | String | false | The fields to be returned |
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 400 (Bad Request) | If any input field is malformed |
| 403 (Forbidden) | If you are not allowed to access the specified stage |
| 410 (Gone) | If this Jive instance is not licensed for the Ideation module |
| 404 (Not Found) | If the specified stage does not exist |
Requires ModuleWhat's this?
This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.
This feature may not be available on all Jive instances.
Get Stages
GET /stagesReturn a list of all idea stages defined in this Jive instance.
Query Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| fields | String | false | The names of the fields to be returned |
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 403 (Forbidden) | If you are not allowed to access the stage information |
| 410 (Gone) | If this Jive instance is not licensed for the Ideation module |
Requires ModuleWhat's this?
This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.
This feature may not be available on all Jive instances.
Update Stage
PUT /stages/{stageID}Update an existing idea stage with the specified characteristics
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| stageID | String | true | The ID of the stage to be updated |
Query Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| fields | String | false | The fields to include in the returned entity |
Takes:
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 400 (Bad Request) | If any input field is malformed |
| 409 (Conflict) | If there is an existing stage with the same name as the proposed one for this stage |
| 403 (Forbidden) | If you are not allowed to update the specified stage object |
| 410 (Gone) | If this Jive instance is not licensed for the Ideation module |
| 404 (Not Found) | If the specified stage object does not exist |