Resource Types

1. Manage Resource Types

This POST method is used to manage resource types.

Request Example

curl --location --request POST '{{url}}/api/resource-manager/resource-types' \
--header 'Authorization: TOKEN {{apiToken}}'
--data-raw '{
  "resourceTypeId": "string",
  "name": "string",
  "description": "string",
  "parameters": [
    {
      "name": "string",
      "paramType": "string",
      "isMandatory": false
    }
  ],
  "createdBy": 0,
  "updatedBy": 0,
  "resourceCount": 0,
  "createdOn": "string",
  "updatedOn": "string"
}'

Response Example 

{
  "resourceTypeId": "string",
  "name": "string",
  "description": "string",
  "parameters": [
    {
      "name": "string",
      "paramType": "string",
      "isMandatory": false
    }
  ],
  "createdBy": 0,
  "updatedBy": 0,
  "resourceCount": 0,
  "createdOn": "string",
  "updatedOn": "string"
}

2. Retrieve All Resource Types

This GET method is used to retrieve a list of all resource types.

Request Parameters

The request parameters used in this method are shown in the following table:

Request Example

curl --location --request GET '{{url}}/api/resource-manager/resource-types' \
--header 'Authorization: TOKEN {{apiToken}}'

Response Example 

{
  "count": 0,
  "page": 0,
  "size": 0,
  "sort": "string",
  "data": [
    {
      "resourceTypeId": "string",
      "name": "string",
      "description": "string",
      "parameters": [
        {
          "name": "string",
          "paramType": "string",
          "isMandatory": false
        }
      ],
      "createdBy": 0,
      "updatedBy": 0,
      "resourceCount": 0,
      "createdOn": "string",
      "updatedOn": "string"
    }
  ]
}

3. Retrieve Resource Type by ID

This GET method is used to manage a resource label.

Request Parameters

The request parameters used in this method are shown in the following table:

Request Example

curl --location --request GET '{{url}}/api/resource-manager/resource-types/{id}' \
--header 'Authorization: TOKEN {{apiToken}}

Response Example 

{
  "resourceTypeId": "string",
  "name": "string",
  "description": "string",
  "parameters": [
    {
      "name": "string",
      "paramType": "string",
      "isMandatory": false
    }
  ],
  "createdBy": 0,
  "updatedBy": 0,
  "resourceCount": 0,
  "createdOn": "string",
  "updatedOn": "string"
}

4. Update Resource Type

This PUT method is used to update the details of a resource type.

Request Parameters

The request parameters used in this method are shown in the following table:

Request Example

curl --location --request PUT '{{url}}/api/resource-manager/resource-types/{id}\ --header 'Authorization: TOKEN {{apiToken}}'
--data-raw '{
  "resourceTypeId": "string",
  "name": "string",
  "description": "string",
  "parameters": [
    {
      "name": "string",
      "paramType": "string",
      "isMandatory": false
    }
  ],
  "createdBy": 0,
  "updatedBy": 0,
  "resourceCount": 0,
  "createdOn": "string",
  "updatedOn": "string"
}'

Response Example 

{
  "resourceTypeId": "string",
  "name": "string",
  "description": "string",
  "parameters": [
    {
      "name": "string",
      "paramType": "string",
      "isMandatory": false
    }
  ],
  "createdBy": 0,
  "updatedBy": 0,
  "resourceCount": 0,
  "createdOn": "string",
  "updatedOn": "string"
}

5. Delete a Resource Type

This DELETE method deletes a resource type.

Request Parameters

The request parameters used in this method are shown in the following table:

Request Example

curl --location --request DELETE '{{url}}/api/resource-manager/resource-types/{id}' \ --header 'Authorization: TOKEN {{apiToken}}'

Response Example 

Resource Type Icon Methods

1. Get Resource Type Icon Data

This GET method retrieves resource type icon data in SVG XML format.

Request Parameters

The request parameters used in this method are shown in the following table:

Request Example

curl --location --request GET '{{url}}/api/resource-manager/resource-types/{id}/icon-data' \ --header 'Authorization: TOKEN {{apiToken}}'

Response Example 

2. Save Resource Type Icon Data

This PUT method saves icon data for a given resource type.

Request Parameters

The request parameters used in this method are shown in the following table:

Request Example

curl --location --request PUT '{{url}}/api/resource-manager/resource-types/{id}/icon-data' \ --header 'Authorization: TOKEN {{apiToken}}'

Response Example 

3. Delete Resource Type Icon Data

This DELETE method deletes icon data for a given resource type.

Request Parameters

The request parameters used in this method are shown in the following table:

Request Example

curl --location --request DELETE '{{url}}/api/resource-manager/resource-types/{id}/icon-data' \ --header 'Authorization: TOKEN {{apiToken}}'

Response Example 

4. Get Resource Type Icon Image

This GET method returns an icon SVG image configured for the resource type. The icon image is returned from the cache, and any updates to the icon take time to refresh the cache. The other APIs to retrieve the icon data or the icon with the updatedTimestamp can be used to obtain the updated icon without delay.

Request Parameters

The request parameters used in this method are shown in the following table:

Request Example

curl --location --request GET '{{url}}/api/resource-manager/resource-types/{id}/icon' \ --header 'Authorization: TOKEN {{apiToken}}'

Response Example 

5. Get Resource Type Updated Icon Image 

This GET method returns an icon SVG image configured for the resource type. The icon image is returned from the cache. The updatedTimestamp value is changed in case any updates to an icon are made, use the latest updatedTimestamp value to get the updated icon. The APIs that return the resource types have the updated icon URL in the response.

Request Parameters

The request parameters used in this method are shown in the following table:

Request Example

curl --location --request GET '{{url}}/api/resource-manager/resource-types/{resourceTypeId}/{updatedTimestamp}/icon' \ --header 'Authorization: TOKEN {{apiToken}}'

Response Example