Your suggested change has been received. Thank you.

close

Suggest A Change

https://thales.na.market.dpondemand.io/docs/dpod/services/kmo….

back

Service Catalog API

TilesApi

search

TilesApi

TilesApi

Method HTTP request Description Scopes
editTile PATCH /tiles/{id} Update the content of a tile. dpod.tenant.spadmin
dpod.tenant.api_spadmin
dpod.tenant.admin
getPlans GET /tiles/{id}/plans Returns the plans for the specified tile. dpod.tenant.appowner
dpod.tenant.api_appowner
getTile GET /tiles/{id} Returns detailed information about a specific tile. dpod.tenant.appowner
dpod.tenant.api_appowner
listTiles GET /tiles Returns a list of all the tiles available to a tenant. dpod.tenant.spadmin
dpod.tenant.api_spadmin
dpod.tenant.admin
dpod.tenant.appowner
dpod.tenant.api_appowner

editTile

Tile editTile(id, patchRequest)

Update a tile to enable or disable it. Supports the JSON Patch format (RFC6902), but currently limited only to setting the \"enabled\" field. Tenant Administrators can set or unset the \"enabled\" field, Service Provider Administrators can only set it. Any attempt to change fields other than \"enabled\" will result in an error. Enabling the tile at Service Provider level will enable all the tiles for the subtenants.

Parameters

Name Type Description Notes
id UUID The ID of the tile to retrieve. Example: 1885fab2-0333-4b05-8c2f-a7459562d4b5 [default to null]
patchRequest List An RFC6902-formatted JSON patch request. Example: [optional]

Return type

Tile

Authorization

OAuth2

  • dpod.tenant.spadmin: Service Provider Administrator
  • dpod.tenant.api_spadmin: Service Provider Administrator API platform credentials
  • dpod.tenant.admin: Tenant Administrator

For more information about authorization see Getting Started Using the DPoD API.

HTTP request headers

  • Content-Type: application/json-patch+json
  • Accept: application/json

getPlans

List getPlans(id)

Returns the plans for the specified tile.

Parameters

Name Type Description Notes
id UUID The ID of the tile whose plans should be retrieved. Example: 1885fab2-0333-4b05-8c2f-a7459562d4b5 [default to null]

Return type

List

Authorization

OAuth2

  • dpod.tenant.appowner: Application Owner
  • dpod.tenant.api_appowner: Application Owner API platform credentials

For more information about authorization see Getting Started Using the DPoD API.

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getTile

Tile getTile(id, provisionable)

Returns detailed information about a specific tile. The tile must be assigned to the tenant that the caller belongs to.

Parameters

Name Type Description Notes
id UUID The ID of the tile to retrieve. Example: 1885fab2-0333-4b05-8c2f-a7459562d4b5 [default to null]
provisionable Boolean When set to true, the api returns a list of the provisionable tiles only (tiles without a redirection URL to 3rd party partner sites). The value is set to false by default resulting in the api returning all the tiles available to the specified tenant ID. [optional] [default to false]

Return type

Tile

Authorization

OAuth2

  • dpod.tenant.appowner: Application Owner
  • dpod.tenant.api_appowner: Application Owner API platform credentials

For more information about authorization see Getting Started Using the DPoD API.

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

listTiles

TileResourceCollection listTiles(page, size, tenantId, provisionable)

Returns a list of the tiles available to the current user, or to the tenant specified in the query parameter.

Parameters

Name Type Description Notes
page Integer Page number to retrieve. Example: 5. If the size is specified and the page number is not, the page number is set to 0. [optional] [default to null]
size Integer Number of results per page. Example: 6. If the page number is specified and the page size is not, the page size is set to 20. [optional] [default to null]
tenantId UUID ID of the tenant to query for tile availability. Service Provider Administrators can use this parameter to query the tiles of their Child Tenants. Other users should not use this parameter; if they do, they must set it to their own tenant's ID. The operator and the maestro service account can use it for any tenant. Example: 7d8e137d-a773-445b-a936-7a2b11c683b5 [optional] [default to null]
provisionable Boolean When set to true, the api returns a list of the provisionable tiles only (tiles without a redirection URL to 3rd party partner sites). The value is set to false by default resulting in the api returning all the tiles available to the specified tenant ID. [optional] [default to false]

Return type

TileResourceCollection

Authorization

OAuth2

  • dpod.tenant.spadmin: Service Provider Administrator
  • dpod.tenant.api_spadmin: Service Provider Administrator API platform credentials
  • dpod.tenant.admin: Tenant Administrator
  • dpod.tenant.appowner: Application Owner
  • dpod.tenant.api_appowner: Application Owner API platform credentials

For more information about authorization see Getting Started Using the DPoD API.

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json