What's on this page

Resource Managers

Associated with each example is a table explaining the fields in the example. This includes the name of the field, a brief description and whether the field is mandatory. Whether a field is required or not is based on the context of the examples. The underlying API definition may mark a field as optional, but in some contexts, the fields must be supplied.

In the examples below field names shown in italics are example names and not the real one to be used in messages.

Create Resource Manager

Creates a record of a Resource Manager within LM and begins the onboarding process. When this request is placed LM will then register the resource manager and then it will request details of all the resource types that the resource manager is able to handle. This may take many seconds.

Request Format

Aspect Value
Endpoint URL /api/resource-managers
HTTP Method POST

Example Request

{

  "name": "test",

  "type": "test-rm",

  "url": "http://localhost:8295/api/resource-manager"

}

Request parameters

Field Description Mandatory
name The name the resource manager instance is to be known by in LM Yes
type The type of resource manager that is being onboarded. This is a string supplied by those managing the resource managers. It is suggested that the same value be used for all resource managers that support the same set of resources No
url The url where LM can find the resource manager interface. Yes

Response Format

Aspect Value
Response Code 201 CREATED

Get Resource Manager

The request gets the information about a Resource Manager within LM. The id in the request is the unique name of the Resource Manager as defined by the “name” field in the Create Resource Manager request (see above).

Request Format

Aspect Value
Endpoint URL /api/resource-managers/{id}
HTTP Method GET

Example Response

{

  "name": "test",

  "type": "test-rm",

  "url": "http://localhost:8295/api/resource-manager"

}

Response properties

Field Description Mandatory
name The name the resource manager instance is to be known by in LM Yes
type The type of resource manager that is being onboarded. This is a string supplied by those managing the resource managers. It is suggested that the same value be used for all resource managers that support the same set of resources No
url The url where the resource manager interface can be found by LM. Yes

Response Format

Aspect Value
Response Code 200 OK

Update Resource Manager

Updates a record of a Resource Manager within LM and begins the onboarding process. The Id in this request if the same as the name in the request body. When this request is made LM will contact the resource manager to enquire of any resources that have been added to the resource manager’s set of resources since the initial creation or last update. No pre-existing resources will be updated within LM in response to this request. To change an existing resource descriptor, the resource would have to be removed from the LM catalog and then this request fired.

Request Format

Aspect Value
Endpoint URL /api/resource-managers/{id}
HTTP Method PUT

Example Requests

{

  "name": "test",

  "type": "test-rm",

  "url": "http://localhost:8295/api/resource-manager"

}

Request parameters

Field Description Mandatory
name The name the resource manager instance is to be known by in LM Yes
type The type of resource manager that is being onboarded. This is a string supplied by those managing the resource managers. It is suggested that the same value be used for all resource managers that support the same set of resources No
url The url where the resource manager interface can be found by LM. Yes

Response Format

Aspect Value
Response Code 200 OK

Delete Resource Manager

A request to delete the record of a Resource Manager within LM. The Id in this request is the name that the resource manager instance is known by LM.

Request Format

Aspect Value
Endpoint URL /api/resource-managers/{id}
HTTP Method DELETE

Response Format

Aspect Value
Response Code 200 OK