Add actionplan list detail api ref
Change-Id: If8bdea3b29049870b222b69ede10669183a3d952
This commit is contained in:
@@ -269,6 +269,21 @@ audittemplate_strategy:
|
|||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
|
||||||
|
created_at:
|
||||||
|
description: |
|
||||||
|
The date and time when the resource was created. The date and time
|
||||||
|
stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
deleted_at:
|
||||||
|
description: |
|
||||||
|
The date and time when the resource was deleted. The date and time
|
||||||
|
stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
|
||||||
# Goal
|
# Goal
|
||||||
goal_display_name:
|
goal_display_name:
|
||||||
description: |
|
description: |
|
||||||
@@ -403,6 +418,13 @@ strategy_uuid:
|
|||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
|
||||||
|
updated_at:
|
||||||
|
description: |
|
||||||
|
The date and time when the resource was updated. The date and time
|
||||||
|
stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
uuid:
|
uuid:
|
||||||
description: |
|
description: |
|
||||||
The UUID for the resource.
|
The UUID for the resource.
|
||||||
|
|||||||
@@ -0,0 +1,26 @@
|
|||||||
|
{
|
||||||
|
"action_plans": [
|
||||||
|
{
|
||||||
|
"state": "ONGOING",
|
||||||
|
"efficacy_indicators": [],
|
||||||
|
"strategy_uuid": "7dae0eea-9df7-42b8-bb3e-313958ff2242",
|
||||||
|
"global_efficacy": [],
|
||||||
|
"links": [
|
||||||
|
{
|
||||||
|
"rel": "self",
|
||||||
|
"href": "http://controller:9322/v1/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"rel": "bookmark",
|
||||||
|
"href": "http://controller:9322/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"updated_at": "2018-04-10T11:59:52.640067+00:00",
|
||||||
|
"strategy_name": "dummy_with_resize",
|
||||||
|
"deleted_at": null,
|
||||||
|
"uuid": "4cbc4ede-0d25-481b-b86e-998dbbd4f8bf",
|
||||||
|
"audit_uuid": "7d100b05-0a86-491f-98a7-f93da19b272a",
|
||||||
|
"created_at": "2018-04-10T11:59:52.640067+00:00"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -98,6 +98,51 @@ Response
|
|||||||
.. literalinclude:: samples/actionplan-list-response.json
|
.. literalinclude:: samples/actionplan-list-response.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
List Action Plan detailed
|
||||||
|
=========================
|
||||||
|
|
||||||
|
.. rest_method:: GET /v1/action_plans/detail
|
||||||
|
|
||||||
|
Returns a list of Action Plan resources with complete details.
|
||||||
|
|
||||||
|
Normal response codes: 200
|
||||||
|
|
||||||
|
Error codes: 400,401
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- audit_uuid: r_audit
|
||||||
|
- strategy: r_strategy
|
||||||
|
- limit: limit
|
||||||
|
- marker: marker
|
||||||
|
- sort_dir: sort_dir
|
||||||
|
- sort_key: sort_key
|
||||||
|
|
||||||
|
Response
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- deleted_at: deleted_at
|
||||||
|
- updated_at: updated_at
|
||||||
|
- created_at: created_at
|
||||||
|
- uuid: uuid
|
||||||
|
- state: actionplan_state
|
||||||
|
- audit_uuid: actionplan_audit_uuid
|
||||||
|
- strategy_uuid: strategy_uuid
|
||||||
|
- strategy_name: strategy_name
|
||||||
|
- efficacy_indicators: actionplan_efficacy_indicators
|
||||||
|
- global_efficacy: actionplan_global_efficacy
|
||||||
|
- links: links
|
||||||
|
|
||||||
|
**Example JSON representation of an Action Plan:**
|
||||||
|
|
||||||
|
.. literalinclude:: samples/actionplan-list-detailed-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
Show Action Plan
|
Show Action Plan
|
||||||
================
|
================
|
||||||
|
|
||||||
@@ -206,4 +251,4 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- actionplan_ident: actionplan_ident
|
- actionplan_ident: actionplan_ident
|
||||||
|
|||||||
Reference in New Issue
Block a user