RESTful Web API (v1)

RESTful Web API (v1)

Goals

type GoalCollection

API representation of a collection of goals.

Data samples:

Json
{
    "goals": [
        {
            "display_name": "Dummy strategy",
            "efficacy_specification": [
                {
                    "description": "Dummy indicator",
                    "name": "dummy",
                    "schema": "Range(min=0, max=100, min_included=True, max_included=True, msg=None)",
                    "unit": "%"
                }
            ],
            "links": [
                {
                    "href": "http://localhost:9322/v1/goals/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
                    "rel": "self"
                },
                {
                    "href": "http://localhost:9322/goals/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
                    "rel": "bookmark"
                }
            ],
            "name": "DUMMY",
            "uuid": "27e3153e-d5bf-4b7e-b517-fb518e17f34c"
        }
    ]
}
goals
Type:list(Goal)

A list containing goals objects

type Goal

API representation of a goal.

This class enforces type checking and value constraints, and converts between the internal object model and the API representation of a goal.

Data samples:

Json
{
    "display_name": "Dummy strategy",
    "efficacy_specification": [
        {
            "description": "Dummy indicator",
            "name": "dummy",
            "schema": "Range(min=0, max=100, min_included=True, max_included=True, msg=None)",
            "unit": "%"
        }
    ],
    "links": [
        {
            "href": "http://localhost:9322/v1/goals/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
            "rel": "self"
        },
        {
            "href": "http://localhost:9322/goals/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
            "rel": "bookmark"
        }
    ],
    "name": "DUMMY",
    "uuid": "27e3153e-d5bf-4b7e-b517-fb518e17f34c"
}
display_name
Type:str

Localized name of the goal

efficacy_specification
Type:json

Efficacy specification for this goal

Type:list(Link)

A list containing a self link and associated audit template links

name
Type:str

Name of the goal

uuid
Type:uuid

Unique UUID for this goal

Strategies

type StrategyCollection

API representation of a collection of strategies.

Data samples:

Json
{
    "strategies": [
        {
            "display_name": "Dummy strategy",
            "goal_name": null,
            "goal_uuid": null,
            "links": [
                {
                    "href": "http://localhost:9322/v1/strategies/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
                    "rel": "self"
                },
                {
                    "href": "http://localhost:9322/strategies/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
                    "rel": "bookmark"
                }
            ],
            "name": "DUMMY",
            "uuid": "27e3153e-d5bf-4b7e-b517-fb518e17f34c"
        }
    ]
}
strategies
Type:list(Strategy)

A list containing strategies objects

type Strategy

API representation of a strategy.

This class enforces type checking and value constraints, and converts between the internal object model and the API representation of a strategy.

Data samples:

Json
{
    "display_name": "Dummy strategy",
    "goal_name": null,
    "goal_uuid": null,
    "links": [
        {
            "href": "http://localhost:9322/v1/strategies/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
            "rel": "self"
        },
        {
            "href": "http://localhost:9322/strategies/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
            "rel": "bookmark"
        }
    ],
    "name": "DUMMY",
    "uuid": "27e3153e-d5bf-4b7e-b517-fb518e17f34c"
}
display_name
Type:str

Localized name of the strategy

goal_name
Type:str

The name of the goal this audit refers to

goal_uuid
Type:str

The UUID of the goal this audit refers to

Type:list(Link)

A list containing a self link and associated goal links

name
Type:str

Name of the strategy

parameters_spec
Type:dict(str: json)

Parameters spec dict

uuid
Type:uuid

Unique UUID for this strategy

Audit Templates

type AuditTemplateCollection

API representation of a collection of audit templates.

Data samples:

Json
{
    "audit_templates": [
        {
            "goal_name": null,
            "goal_uuid": null,
            "links": [
                {
                    "href": "http://localhost:9322/v1/audit_templates/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
                    "rel": "self"
                },
                {
                    "href": "http://localhost:9322/audit_templates/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
                    "rel": "bookmark"
                }
            ],
            "name": "My Audit Template",
            "scope": [],
            "strategy_name": null,
            "strategy_uuid": null,
            "uuid": "27e3153e-d5bf-4b7e-b517-fb518e17f34c"
        }
    ]
}
audit_templates
Type:list(AuditTemplate)

A list containing audit templates objects

type AuditTemplate

API representation of a audit template.

This class enforces type checking and value constraints, and converts between the internal object model and the API representation of an audit template.

Data samples:

Json
{
    "created_at": "2019-04-17T22:04:02.418090",
    "deleted_at": null,
    "description": "Description of my audit template",
    "goal_name": null,
    "goal_uuid": null,
    "links": [
        {
            "href": "http://localhost:9322/v1/audit_templates/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
            "rel": "self"
        },
        {
            "href": "http://localhost:9322/audit_templates/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
            "rel": "bookmark"
        }
    ],
    "name": "My Audit Template",
    "scope": [],
    "strategy_name": null,
    "strategy_uuid": null,
    "updated_at": "2019-04-17T22:04:02.418091",
    "uuid": "27e3153e-d5bf-4b7e-b517-fb518e17f34c"
}
audits
Type:list(Link)

Links to the collection of audits contained in this audit template

description
Type:str

Short description of this audit template

goal_name
Type:str

The name of the goal this audit template refers to

goal_uuid
Type:str

Goal UUID the audit template refers to

Type:list(Link)

A list containing a self link and associated audit template links

name
Type:str

Name of this audit template

scope
Type:json

Audit Scope

strategy_name
Type:str

The name of the strategy this audit template refers to

strategy_uuid
Type:str

Strategy UUID the audit template refers to

uuid
Type:uuid

Unique UUID for this audit template

Audits

type AuditCollection

API representation of a collection of audits.

Data samples:

Json
{
    "audits": [
        {
            "audit_type": "ONESHOT",
            "auto_trigger": false,
            "goal_name": null,
            "goal_uuid": null,
            "interval": "7200",
            "links": [
                {
                    "href": "http://localhost:9322/v1/audits/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
                    "rel": "self"
                },
                {
                    "href": "http://localhost:9322/audits/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
                    "rel": "bookmark"
                }
            ],
            "name": "My Audit",
            "next_run_time": "2019-04-17T22:04:02.488358",
            "scope": [],
            "state": "PENDING",
            "strategy_name": null,
            "strategy_uuid": null,
            "uuid": "27e3153e-d5bf-4b7e-b517-fb518e17f34c"
        }
    ]
}
audits
Type:list(Audit)

A list containing audits objects

type Audit

API representation of an audit.

This class enforces type checking and value constraints, and converts between the internal object model and the API representation of an audit.

Data samples:

Json
{
    "audit_type": "ONESHOT",
    "auto_trigger": false,
    "created_at": "2019-04-17T22:04:02.495901",
    "deleted_at": null,
    "goal_name": null,
    "goal_uuid": null,
    "interval": "7200",
    "links": [
        {
            "href": "http://localhost:9322/v1/audits/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
            "rel": "self"
        },
        {
            "href": "http://localhost:9322/audits/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
            "rel": "bookmark"
        }
    ],
    "name": "My Audit",
    "next_run_time": "2019-04-17T22:04:02.495903",
    "scope": [],
    "state": "PENDING",
    "strategy_name": null,
    "strategy_uuid": null,
    "updated_at": "2019-04-17T22:04:02.495903",
    "uuid": "27e3153e-d5bf-4b7e-b517-fb518e17f34c"
}
audit_type
Type:str

Type of this audit

auto_trigger
Type:bool

Autoexecute action plan once audit is succeeded

goal_name
Type:str

The name of the goal this audit refers to

goal_uuid
Type:str

Goal UUID the audit refers to

hostname
Type:str

Hostname the audit is running on

interval
Type:str

Launch audit periodically (in seconds)

Type:list(Link)

A list containing a self link and associated audit links

name
Type:str

Name of this audit

next_run_time
Type:datetime

The next time audit launch

parameters
Type:dict(str: json)

The strategy parameters for this audit

scope
Type:json

Audit Scope

state
Type:str

This audit state

strategy_name
Type:str

The name of the strategy this audit refers to

strategy_uuid
Type:str

Strategy UUID the audit refers to

uuid
Type:uuid

Unique UUID for this audit

Action Plans

type ActionPlanCollection

API representation of a collection of action_plans.

Data samples:

Json
{
    "action_plans": [
        {
            "audit_uuid": "abcee106-14d3-4515-b744-5a26885cf6f6",
            "efficacy_indicators": [
                {
                    "description": "Test indicator",
                    "name": "test_indicator",
                    "unit": "%"
                }
            ],
            "links": [
                {
                    "href": "http://localhost:9322/v1/action_plans/9ef4d84c-41e8-4418-9220-ce55be0436af",
                    "rel": "self"
                },
                {
                    "href": "http://localhost:9322/action_plans/9ef4d84c-41e8-4418-9220-ce55be0436af",
                    "rel": "bookmark"
                }
            ],
            "state": "ONGOING",
            "strategy_name": null,
            "strategy_uuid": null,
            "updated_at": "2019-04-17T22:04:02.582236",
            "uuid": "9ef4d84c-41e8-4418-9220-ce55be0436af"
        }
    ]
}
action_plans
Type:list(ActionPlan)

A list containing action_plans objects

type ActionPlan

API representation of a action plan.

This class enforces type checking and value constraints, and converts between the internal object model and the API representation of an action plan.

Data samples:

Json
{
    "audit_uuid": "abcee106-14d3-4515-b744-5a26885cf6f6",
    "created_at": "2019-04-17T22:04:02.589140",
    "deleted_at": null,
    "efficacy_indicators": [
        {
            "description": "Test indicator",
            "name": "test_indicator",
            "unit": "%"
        }
    ],
    "links": [
        {
            "href": "http://localhost:9322/v1/action_plans/9ef4d84c-41e8-4418-9220-ce55be0436af",
            "rel": "self"
        },
        {
            "href": "http://localhost:9322/action_plans/9ef4d84c-41e8-4418-9220-ce55be0436af",
            "rel": "bookmark"
        }
    ],
    "state": "ONGOING",
    "strategy_name": null,
    "strategy_uuid": null,
    "updated_at": "2019-04-17T22:04:02.589142",
    "uuid": "9ef4d84c-41e8-4418-9220-ce55be0436af"
}
audit_uuid
Type:uuid

The UUID of the audit this port belongs to

efficacy_indicators
Type:json

The list of efficacy indicators associated to this action plan

global_efficacy
Type:json

The global efficacy of this action plan

hostname
Type:str

Hostname the actionplan is running on

Type:list(Link)

A list containing a self link and associated action links

state
Type:str

This action plan state

strategy_name
Type:str

The name of the strategy this action plan refers to

strategy_uuid
Type:str

Strategy UUID the action plan refers to

uuid
Type:uuid

Unique UUID for this action plan

Actions

type ActionCollection

API representation of a collection of actions.

Data samples:

Json
{
    "actions": [
        {
            "action_plan_uuid": "7ae81bb3-dec3-4289-8d6c-da80bd8001ae",
            "links": [
                {
                    "href": "http://localhost:9322/v1/actions/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
                    "rel": "self"
                },
                {
                    "href": "http://localhost:9322/actions/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
                    "rel": "bookmark"
                }
            ],
            "parents": [],
            "state": "PENDING",
            "uuid": "27e3153e-d5bf-4b7e-b517-fb518e17f34c"
        }
    ]
}
actions
Type:list(Action)

A list containing actions objects

type Action

API representation of a action.

This class enforces type checking and value constraints, and converts between the internal object model and the API representation of a action.

Data samples:

Json
{
    "action_plan_uuid": "7ae81bb3-dec3-4289-8d6c-da80bd8001ae",
    "created_at": "2019-04-17T22:04:02.646803",
    "deleted_at": null,
    "links": [
        {
            "href": "http://localhost:9322/v1/actions/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
            "rel": "self"
        },
        {
            "href": "http://localhost:9322/actions/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
            "rel": "bookmark"
        }
    ],
    "parents": [],
    "state": "PENDING",
    "updated_at": "2019-04-17T22:04:02.646805",
    "uuid": "27e3153e-d5bf-4b7e-b517-fb518e17f34c"
}
action_plan_uuid
Type:uuid

The action plan this action belongs to

action_type
Type:str

Action type

description
Type:str

Action description

input_parameters
Type:json

One or more key/value pairs

Type:list(Link)

A list containing a self link and associated action links

parents
Type:json

UUIDs of parent actions

state
Type:str

This audit state

uuid
Type:uuid

Unique UUID for this action

Scoring Engine

type ScoringEngineCollection

API representation of a collection of scoring engines.

Data samples:

Json
{
    "scoring_engines": [
        {
            "description": "Sample Scoring Engine 123 just for testing",
            "links": [
                {
                    "href": "http://localhost:9322/v1/scoring_engines/81bbd3c7-3b08-4d12-a268-99354dbf7b71",
                    "rel": "self"
                },
                {
                    "href": "http://localhost:9322/scoring_engines/81bbd3c7-3b08-4d12-a268-99354dbf7b71",
                    "rel": "bookmark"
                }
            ],
            "name": "sample-se-123",
            "uuid": "81bbd3c7-3b08-4d12-a268-99354dbf7b71"
        }
    ]
}
scoring_engines
Type:list(ScoringEngine)

A list containing scoring engine objects

type ScoringEngine

API representation of a scoring engine.

This class enforces type checking and value constraints, and converts between the internal object model and the API representation of a scoring engine.

Data samples:

Json
{
    "description": "Sample Scoring Engine 123 just for testing",
    "links": [
        {
            "href": "http://localhost:9322/v1/scoring_engines/81bbd3c7-3b08-4d12-a268-99354dbf7b71",
            "rel": "self"
        },
        {
            "href": "http://localhost:9322/scoring_engines/81bbd3c7-3b08-4d12-a268-99354dbf7b71",
            "rel": "bookmark"
        }
    ],
    "name": "sample-se-123",
    "uuid": "81bbd3c7-3b08-4d12-a268-99354dbf7b71"
}
description
Type:str

A human readable description of the Scoring Engine

Type:list(Link)

A list containing a self link and associated action links

metainfo
Type:str

A metadata associated with the scoring engine

name
Type:str

The name of the scoring engine

uuid
Type:uuid

Unique UUID of the scoring engine

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.