INF O2 Services API 1.0.0

Description

Swagger OpenAPI document for INF O2 Services

Base URL

http(s)://<OAM IP>:30205/

O2DMS_LCM

DMS LCM related operations.

POST /o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment

Parameters

Name	Located in	Required	Type	Format	Properties	Description
deploymentManagerID	path	Yes	string			ID of the deployment manager

Request

Headers

X-Fields: An optional fields mask

Body

Name	Required	Type	Format	Properties	Description
description	No	string
descriptorId	No	string
name	No	string
parentDeploymentId	No	string

{
    "description": "somestring",
    "descriptorId": "somestring",
    "name": "somestring",
    "parentDeploymentId": "somestring"
}

Responses

201

Success

Type: NfDeploymentCreateRespDto

Example:

{
    "id": "somestring"
}

404

DMS LCM not found

POST /o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor

Parameters

Name	Located in	Required	Type	Format	Properties	Description
deploymentManagerID	path	Yes	string			ID of the deployment manager

Request

Headers

X-Fields: An optional fields mask

Body

Name	Required	Type	Format	Properties	Description
artifactName	No	string
artifactRepoUrl	No	string
description	No	string
inputParams	No	string
name	No	string
outputParams	No	string

{
    "artifactName": "somestring",
    "artifactRepoUrl": "somestring",
    "description": "somestring",
    "inputParams": "somestring",
    "name": "somestring",
    "outputParams": "somestring"
}

Responses

201

Success

Type: NfDeploymentDescriptorCreateRespDto

Example:

{
    "id": "somestring"
}

404

DMS LCM not found

DELETE /o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment/{nfDeploymentId}

Parameters

Name	Located in	Required	Type	Format	Properties	Description
nfDeploymentId	path	Yes	string			ID of the NfDeployment
deploymentManagerID	path	Yes	string			ID of the deployment manager

Request

Responses

204

NfDeployment deleted

404

DMS LCM not found

DELETE /o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor/{nfDeploymentDescriptorId}

Parameters

Name	Located in	Required	Type	Format	Properties	Description
nfDeploymentDescriptorId	path	Yes	string			ID of the NfDeploymentDescriptor
deploymentManagerID	path	Yes	string			ID of the deployment manager

Request

Responses

204

NfDeploymentDescriptor deleted

404

DMS LCM not found

GET /o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment/{nfDeploymentId}

Parameters

Name	Located in	Required	Type	Format	Properties	Description
nfDeploymentId	path	Yes	string			ID of the NfDeployment
deploymentManagerID	path	Yes	string			ID of the deployment manager

Request

Headers

X-Fields: An optional fields mask

Responses

200

Success

Type: NfDeploymentGetDto

Example:

{
    "description": "somestring",
    "descriptorId": "somestring",
    "id": "somestring",
    "name": "somestring",
    "parentDeploymentId": "somestring",
    "status": 1
}

404

DMS LCM not found

GET /o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor/{nfDeploymentDescriptorId}

Parameters

Name	Located in	Required	Type	Format	Properties	Description
nfDeploymentDescriptorId	path	Yes	string			ID of the NfDeploymentDescriptor
deploymentManagerID	path	Yes	string			ID of the deployment manager

Request

Headers

X-Fields: An optional fields mask

Responses

200

Success

Type: NfDeploymentDescriptorGetDto

Example:

{
    "artifactName": "somestring",
    "artifactRepoUrl": "somestring",
    "description": "somestring",
    "id": "somestring",
    "inputParams": "somestring",
    "name": "somestring",
    "outputParams": "somestring"
}

404

DMS LCM not found

GET /o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment

Parameters

Name	Located in	Required	Type	Format	Properties	Description
deploymentManagerID	path	Yes	string			ID of the deployment manager

Request

Headers

X-Fields: An optional fields mask

Responses

200

Success

Type: array of NfDeploymentGetDto

Example:

[
    {
        "description": "somestring",
        "descriptorId": "somestring",
        "id": "somestring",
        "name": "somestring",
        "parentDeploymentId": "somestring",
        "status": 1
    },
    {
        "description": "somestring",
        "descriptorId": "somestring",
        "id": "somestring",
        "name": "somestring",
        "parentDeploymentId": "somestring",
        "status": 1
    }
]

404

DMS LCM not found

GET /o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor

Parameters

Name	Located in	Required	Type	Format	Properties	Description
deploymentManagerID	path	Yes	string			ID of the deployment manager

Request

Headers

X-Fields: An optional fields mask

Responses

200

Success

Type: array of NfDeploymentDescriptorGetDto

Example:

[
    {
        "artifactName": "somestring",
        "artifactRepoUrl": "somestring",
        "description": "somestring",
        "id": "somestring",
        "inputParams": "somestring",
        "name": "somestring",
        "outputParams": "somestring"
    },
    {
        "artifactName": "somestring",
        "artifactRepoUrl": "somestring",
        "description": "somestring",
        "id": "somestring",
        "inputParams": "somestring",
        "name": "somestring",
        "outputParams": "somestring"
    }
]

404

DMS LCM not found

GET /o2dms/{deploymentManagerID}

Parameters

Name	Located in	Required	Type	Format	Properties	Description
deploymentManagerID	path	Yes	string			ID of the deployment manager

Request

Headers

X-Fields: An optional fields mask

Responses

200

Success

Type: DmsGetDto

Example:

{
    "capabilities": "somestring",
    "capacity": "somestring",
    "deploymentManagerId": "somestring",
    "description": "somestring",
    "name": "somestring",
    "supportedLocations": "somestring"
}

404

Deployment manager not found

PUT /o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment/{nfDeploymentId}

Parameters

Name	Located in	Required	Type	Format	Properties	Description
nfDeploymentId	path	Yes	string			ID of the NfDeployment
deploymentManagerID	path	Yes	string			ID of the deployment manager

Request

Body

Name	Required	Type	Format	Properties	Description
description	No	string
name	No	string
parentDeploymentId	No	string

{
    "description": "somestring",
    "name": "somestring",
    "parentDeploymentId": "somestring"
}

Responses

404

DMS LCM not found

PUT /o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor/{nfDeploymentDescriptorId}

Parameters

Name	Located in	Required	Type	Format	Properties	Description
nfDeploymentDescriptorId	path	Yes	string			ID of the NfDeploymentDescriptor
deploymentManagerID	path	Yes	string			ID of the deployment manager

Request

Body

Name	Required	Type	Format	Properties	Description
artifactName	No	string
artifactRepoUrl	No	string
description	No	string
inputParams	No	string
name	No	string
outputParams	No	string

{
    "artifactName": "somestring",
    "artifactRepoUrl": "somestring",
    "description": "somestring",
    "inputParams": "somestring",
    "name": "somestring",
    "outputParams": "somestring"
}

Responses

404

DMS LCM not found

O2IMS_INVENTORY

IMS Inventory related operations.

POST /o2ims_infrastructureInventory/v1/subscriptions

Request

Headers

X-Fields: An optional fields mask

Body

Name	Required	Type	Format	Properties	Description
callback	Yes	string			Subscription callback address
consumerSubscriptionId	No	string
filter	No	string

{
    "callback": "somestring",
    "consumerSubscriptionId": "somestring",
    "filter": "somestring"
}

Responses

201

Success

Type: SubscriptionCreatedRespDto

Example:

{
    "subscriptionId": "somestring"
}

DELETE /o2ims_infrastructureInventory/v1/subscriptions/{subscriptionID}

Parameters

Name	Located in	Required	Type	Format	Properties	Description
subscriptionID	path	Yes	string			ID of the subscription

Request

Responses

204

Subscription deleted

404

Subscription not found

GET /o2ims_infrastructureInventory/v1/deploymentManagers/{deploymentManagerID}

Parameters

Name	Located in	Required	Type	Format	Properties	Description
deploymentManagerID	path	Yes	string			ID of the deployment manager

Request

Headers

X-Fields: An optional fields mask

Responses

200

Success

Type: DeploymentManagerGetDto

Example:

{
    "capabilities": "somestring",
    "capacity": "somestring",
    "deploymentManagementServiceEndpoint": "somestring",
    "deploymentManagerId": "somestring",
    "description": "somestring",
    "name": "somestring",
    "supportedLocations": "somestring"
}

404

Deployment manager not found

GET /o2ims_infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources/{resourceID}

Parameters

Name	Located in	Required	Type	Format	Properties	Description
resourceID	path	Yes	string			ID of the resource
resourcePoolID	path	Yes	string			ID of the resource pool

Request

Headers

X-Fields: An optional fields mask

Responses

200

Success

Type: ResourceGetDto2

Example:

{
    "children": [
        {
            "children": [
                {
                    "description": "somestring",
                    "elements": "somestring",
                    "name": "somestring",
                    "parentId": "somestring",
                    "resourceId": "somestring",
                    "resourcePoolId": "somestring",
                    "resourceTypeId": "somestring"
                },
                {
                    "description": "somestring",
                    "elements": "somestring",
                    "name": "somestring",
                    "parentId": "somestring",
                    "resourceId": "somestring",
                    "resourcePoolId": "somestring",
                    "resourceTypeId": "somestring"
                }
            ],
            "description": "somestring",
            "elements": "somestring",
            "name": "somestring",
            "parentId": "somestring",
            "resourceId": "somestring",
            "resourcePoolId": "somestring",
            "resourceTypeId": "somestring"
        },
        {
            "children": [
                {
                    "description": "somestring",
                    "elements": "somestring",
                    "name": "somestring",
                    "parentId": "somestring",
                    "resourceId": "somestring",
                    "resourcePoolId": "somestring",
                    "resourceTypeId": "somestring"
                },
                {
                    "description": "somestring",
                    "elements": "somestring",
                    "name": "somestring",
                    "parentId": "somestring",
                    "resourceId": "somestring",
                    "resourcePoolId": "somestring",
                    "resourceTypeId": "somestring"
                }
            ],
            "description": "somestring",
            "elements": "somestring",
            "name": "somestring",
            "parentId": "somestring",
            "resourceId": "somestring",
            "resourcePoolId": "somestring",
            "resourceTypeId": "somestring"
        }
    ],
    "description": "somestring",
    "elements": "somestring",
    "name": "somestring",
    "parentId": "somestring",
    "resourceId": "somestring",
    "resourcePoolId": "somestring",
    "resourceTypeId": "somestring"
}

404

Resource not found

GET /o2ims_infrastructureInventory/v1/resourcePools/{resourcePoolID}

Parameters

Name	Located in	Required	Type	Format	Properties	Description
resourcePoolID	path	Yes	string			ID of the resource pool

Request

Headers

X-Fields: An optional fields mask

Responses

200

Success

Type: ResourcePoolGetDto

Example:

{
    "description": "somestring",
    "globalLocationId": "somestring",
    "location": "somestring",
    "name": "somestring",
    "resourcePoolId": "somestring"
}

404

Resource pool not found

GET /o2ims_infrastructureInventory/v1/resourceTypes/{resourceTypeID}

Parameters

Name	Located in	Required	Type	Format	Properties	Description
resourceTypeID	path	Yes	string			ID of the resource type

Request

Headers

X-Fields: An optional fields mask

Responses

200

Success

Type: ResourceTypeGetDto

Example:

{
    "description": "somestring",
    "name": "somestring",
    "resourceTypeId": "somestring",
    "vendor": "somestring",
    "version": "somestring"
}

404

Resource type not found

GET /o2ims_infrastructureInventory/v1/subscriptions/{subscriptionID}

Parameters

Name	Located in	Required	Type	Format	Properties	Description
subscriptionID	path	Yes	string			ID of the subscription

Request

Headers

X-Fields: An optional fields mask

Responses

200

Success

Type: SubscriptionGetDto

Example:

{
    "callback": "somestring",
    "consumerSubscriptionId": "somestring",
    "filter": "somestring",
    "subscriptionId": "somestring"
}

404

Subscription not found

GET /o2ims_infrastructureInventory/v1/subscriptions

Request

Headers

X-Fields: An optional fields mask

Responses

200

Success

Type: array of SubscriptionGetDto

Example:

[
    {
        "callback": "somestring",
        "consumerSubscriptionId": "somestring",
        "filter": "somestring",
        "subscriptionId": "somestring"
    },
    {
        "callback": "somestring",
        "consumerSubscriptionId": "somestring",
        "filter": "somestring",
        "subscriptionId": "somestring"
    }
]

GET /o2ims_infrastructureInventory/v1/deploymentManagers

Request

Headers

X-Fields: An optional fields mask

Responses

200

Success

Type: array of DeploymentManagerGetDto

Example:

[
    {
        "capabilities": "somestring",
        "capacity": "somestring",
        "deploymentManagementServiceEndpoint": "somestring",
        "deploymentManagerId": "somestring",
        "description": "somestring",
        "name": "somestring",
        "supportedLocations": "somestring"
    },
    {
        "capabilities": "somestring",
        "capacity": "somestring",
        "deploymentManagementServiceEndpoint": "somestring",
        "deploymentManagerId": "somestring",
        "description": "somestring",
        "name": "somestring",
        "supportedLocations": "somestring"
    }
]

GET /o2ims_infrastructureInventory/v1/

Request

Headers

X-Fields: An optional fields mask

Responses

200

Success

Type: OcloudDto

Example:

{
    "description": "somestring",
    "globalCloudId": "somestring",
    "infrastructureManagementServiceEndpoint": "somestring",
    "name": "somestring",
    "oCloudId": "somestring"
}

404

oCloud not found

GET /o2ims_infrastructureInventory/v1/resourcePools

Request

Headers

X-Fields: An optional fields mask

Responses

200

Success

Type: array of ResourcePoolGetDto

Example:

[
    {
        "description": "somestring",
        "globalLocationId": "somestring",
        "location": "somestring",
        "name": "somestring",
        "resourcePoolId": "somestring"
    },
    {
        "description": "somestring",
        "globalLocationId": "somestring",
        "location": "somestring",
        "name": "somestring",
        "resourcePoolId": "somestring"
    }
]

GET /o2ims_infrastructureInventory/v1/resourceTypes

Request

Headers

X-Fields: An optional fields mask

Responses

200

Success

Type: array of ResourceTypeGetDto

Example:

[
    {
        "description": "somestring",
        "name": "somestring",
        "resourceTypeId": "somestring",
        "vendor": "somestring",
        "version": "somestring"
    },
    {
        "description": "somestring",
        "name": "somestring",
        "resourceTypeId": "somestring",
        "vendor": "somestring",
        "version": "somestring"
    }
]

GET /o2ims_infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources

Parameters

Name	Located in	Required	Type	Format	Properties	Description
resourcePoolID	path	Yes	string			ID of the resource pool

Request

Headers

X-Fields: An optional fields mask

Responses

200

Success

Type: array of ResourceListDto

Example:

[
    {
        "description": "somestring",
        "name": "somestring",
        "parentId": "somestring",
        "resourceId": "somestring",
        "resourcePoolId": "somestring",
        "resourceTypeId": "somestring"
    },
    {
        "description": "somestring",
        "name": "somestring",
        "parentId": "somestring",
        "resourceId": "somestring",
        "resourcePoolId": "somestring",
        "resourceTypeId": "somestring"
    }
]

PROVISION

Provision related operations.

POST /provision/v1/smo-endpoint

Request

Headers

X-Fields: An optional fields mask

Body

Name	Required	Type	Format	Properties	Description
endpoint	Yes	string			Configuration SMO callback address

{
    "endpoint": "somestring"
}

Responses

201

Success

Type: SmoEndpointCreatedRespDto

Example:

{
    "id": "somestring"
}

DELETE /provision/v1/smo-endpoint/{configurationID}

Parameters

Name	Located in	Required	Type	Format	Properties	Description
configurationID	path	Yes	string			ID of the SMO endpoint configuration

Request

Responses

204

Configuration deleted

404

SMO Endpoint configuration not found

GET /provision/v1/smo-endpoint/{configurationID}

Parameters

Name	Located in	Required	Type	Format	Properties	Description
configurationID	path	Yes	string			ID of the SMO endpoint configuration

Request

Headers

X-Fields: An optional fields mask

Responses

200

Success

Type: SmoEndpointGetDto

Example:

{
    "comments": "somestring",
    "endpoint": "somestring",
    "id": "somestring",
    "status": "somestring"
}

404

SMO Endpoint configuration not found

GET /provision/v1/smo-endpoint

Request

Headers

X-Fields: An optional fields mask

Responses

200

Success

Type: array of SmoEndpointGetDto

Example:

[
    {
        "comments": "somestring",
        "endpoint": "somestring",
        "id": "somestring",
        "status": "somestring"
    },
    {
        "comments": "somestring",
        "endpoint": "somestring",
        "id": "somestring",
        "status": "somestring"
    }
]

Data Structures

DeploymentManagerGetDto Model Structure

Name	Required	Type	Format	Properties	Description
capabilities	No	string
capacity	No	string
deploymentManagementServiceEndpoint	No	string
deploymentManagerId	Yes	string			Deployment manager ID
description	No	string
name	No	string
supportedLocations	No	string

DmsGetDto Model Structure

Name	Required	Type	Format	Properties	Description
capabilities	No	string
capacity	No	string
deploymentManagerId	Yes	string			Deployment manager ID
description	No	string
name	No	string
supportedLocations	No	string

NfDeploymentCreateDto Model Structure

Name	Required	Type	Format	Properties	Description
description	No	string
descriptorId	No	string
name	No	string
parentDeploymentId	No	string

NfDeploymentCreateRespDto Model Structure

Name	Required	Type	Format	Properties	Description
id	Yes	string			NfDeployment ID

NfDeploymentDescriptorCreateDto Model Structure

Name	Required	Type	Format	Properties	Description
artifactName	No	string
artifactRepoUrl	No	string
description	No	string
inputParams	No	string
name	No	string
outputParams	No	string

NfDeploymentDescriptorCreateRespDto Model Structure

Name	Required	Type	Format	Properties	Description
id	Yes	string			NfDeploymentDescriptor ID

NfDeploymentDescriptorGetDto Model Structure

Name	Required	Type	Format	Properties	Description
artifactName	No	string
artifactRepoUrl	No	string
description	No	string
id	Yes	string			NfDeploymentDescriptor ID
inputParams	No	string
name	No	string
outputParams	No	string

NfDeploymentDescriptorUpdateDto Model Structure

Name	Required	Type	Format	Properties	Description
artifactName	No	string
artifactRepoUrl	No	string
description	No	string
inputParams	No	string
name	No	string
outputParams	No	string

NfDeploymentGetDto Model Structure

Name	Required	Type	Format	Properties	Description
description	No	string
descriptorId	No	string
id	Yes	string			NfDeployment ID
name	No	string
parentDeploymentId	No	string
status	No	integer

NfDeploymentUpdateDto Model Structure

Name	Required	Type	Format	Properties	Description
description	No	string
name	No	string
parentDeploymentId	No	string

OcloudDto Model Structure

Name	Required	Type	Format	Properties	Description
description	No	string
globalCloudId	No	string
infrastructureManagementServiceEndpoint	No	string
name	No	string
oCloudId	Yes	string

ResourceGetDto0 Model Structure

Name	Required	Type	Format	Properties	Description
description	No	string
elements	No	string
name	No	string
parentId	No	string
resourceId	Yes	string			Resource ID
resourcePoolId	No	string
resourceTypeId	No	string

ResourceGetDto1 Model Structure

Name	Required	Type	Format	Properties	Description
children	No	array of ResourceGetDto0
description	No	string
elements	No	string
name	No	string
parentId	No	string
resourceId	Yes	string			Resource ID
resourcePoolId	No	string
resourceTypeId	No	string

ResourceGetDto2 Model Structure

Name	Required	Type	Format	Properties	Description
children	No	array of ResourceGetDto1
description	No	string
elements	No	string
name	No	string
parentId	No	string
resourceId	Yes	string			Resource ID
resourcePoolId	No	string
resourceTypeId	No	string

ResourceListDto Model Structure

Name	Required	Type	Format	Properties	Description
description	No	string
name	No	string
parentId	No	string
resourceId	Yes	string			Resource ID
resourcePoolId	No	string
resourceTypeId	No	string

ResourcePoolGetDto Model Structure

Name	Required	Type	Format	Properties	Description
description	No	string
globalLocationId	No	string
location	No	string
name	No	string
resourcePoolId	Yes	string			Resource pool ID

ResourceTypeGetDto Model Structure

Name	Required	Type	Format	Properties	Description
description	No	string
name	No	string
resourceTypeId	Yes	string			Resource type ID
vendor	No	string
version	No	string

SmoEndpointCreateDto Model Structure

Name	Required	Type	Format	Properties	Description
endpoint	Yes	string			Configuration SMO callback address

SmoEndpointCreatedRespDto Model Structure

Name	Required	Type	Format	Properties	Description
id	Yes	string			SMO Endpoint Configuration ID

SmoEndpointGetDto Model Structure

Name	Required	Type	Format	Properties	Description
comments	No	string
endpoint	No	string
id	Yes	string			SMO Endpoint Configuration ID
status	No	string

SubscriptionCreateDto Model Structure

Name	Required	Type	Format	Properties	Description
callback	Yes	string			Subscription callback address
consumerSubscriptionId	No	string
filter	No	string

SubscriptionCreatedRespDto Model Structure

Name	Required	Type	Format	Properties	Description
subscriptionId	Yes	string			Subscription ID

SubscriptionGetDto Model Structure

Name	Required	Type	Format	Properties	Description
callback	No	string
consumerSubscriptionId	No	string
filter	No	string
subscriptionId	Yes	string			Subscription ID