providerResource
A simplified representation of a Resource used by a provider application for
registration purposes.
This Object is very similar to the Resource Entity except:
- The Id field which contains the external Id used by the provider instead of the internal
Entity Id.
- The catalogItemRequestId which contains the external Request Id of the request associated to
the Resource.
XML
Elements
| name (type) |
min/max
occurs |
description |
|
id (string)
|
0/1 |
Unique identifier of this resource.
|
|
resourceTypeId (string)
|
0/1 |
Id of the resource type.
|
|
name (string)
|
0/1 |
User friendly name of the provider resource.
|
|
description (string)
|
0/1 |
Brief description of the provider resource.
|
|
organization (catalogOrganizationReference)
|
0/1 |
Subtenant and/or tenant of the provider resource.
|
|
parentResourceId (string)
|
0/1 |
Id of the parent of this resource.
|
|
catalogItemId (string)
|
0/1 |
The external/provider/binding id of the CatalogItem which defines this resource.
|
|
catalogItemRequestId (string)
|
0/1 |
The external/provider/binding id of the Request which provisioned this resource.
|
|
owners (catalogPrincipal)
|
0/unbounded |
|
|
lease (resourceLease)
|
0/1 |
The resource's current lease.
|
|
costs (resourceCosts)
|
0/1 |
An optional rate card of the costs/charges levied against the resource.
|
|
data (literalMap)
|
0/1 |
An optional area to record the extended properties of a Resource. This is useful to:
- show values for additional columns in the items summary when the provider does NOT
support the "list" callback;
- pass additional, required data to extensions, forms etc when reviewing a resource and the
provider does not support the "details" callback.
|
|
archiveDays (int)
|
1/1 |
The number of days for the archive period.
|
JSON
| property |
type |
description |
| id |
id (string)
|
Unique identifier of this resource.
|
| resourceTypeId |
resourceTypeId (string)
|
Id of the resource type.
|
| name |
name (string)
|
User friendly name of the provider resource.
|
| description |
description (string)
|
Brief description of the provider resource.
|
| organization |
organization (catalogOrganizationReference)
|
Subtenant and/or tenant of the provider resource.
|
| parentResourceId |
parentResourceId (string)
|
Id of the parent of this resource.
|
| catalogItemId |
catalogItemId (string)
|
The external/provider/binding id of the CatalogItem which defines this resource.
|
| catalogItemRequestId |
catalogItemRequestId (string)
|
The external/provider/binding id of the Request which provisioned this resource.
|
| owners |
array of owners (catalogPrincipal)
|
|
| lease |
lease (resourceLease)
|
The resource's current lease.
|
| costs |
costs (resourceCosts)
|
An optional rate card of the costs/charges levied against the resource.
|
| data |
data (literalMap)
|
An optional area to record the extended properties of a Resource. This is useful to:
- show values for additional columns in the items summary when the provider does NOT
support the "list" callback;
- pass additional, required data to extensions, forms etc when reviewing a resource and the
provider does not support the "details" callback.
|
| archiveDays |
archiveDays (int)
|
The number of days for the archive period.
|