Previous topic

ExternalIdentifiers

Next topic

Other

ItemProfile

For each resource sold by a vendor, typically there is a vendor-specific ID and MPN (Manufacturer Part Number). Those properties help the provider to collect data about provisioned resources and generate business reports with detailed commerce information about each resource. When implemented by a custom APS type, the ItemProfile APS type adds the above-mentioned properties to the APS resources based on that custom APS type.

Schema

The considered APS type (download) looks as follows:

{
  "name": "ItemProfile",
  "id": "http://aps-standard.org/types/core/profile/item/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "properties": {
    "itemId": {
      "type": "string",
      "title": "Item Identifier"
    },
    "mpn": {
	  "type": "string",
	  "title": "MPN"
        }
  }
}

Properties

The ItemProfile APS type defines two properties:

  • itemId: a vendor-specific ID assigned to the provisioned resource. The provider must not change it.

  • mpn: a product MPN related to the resource typically assigned by the vendor. The provider also can set it in accordance with the vendor contract.

Implementation

We recommended implementing this APS type in custom APS types used to create service reference resources. Such custom APS types typically implement the ServiceProfile APS type as well.

Example

An APS package considered here contains a custom sampleItemProfile APS type that implements ServiceProfile and ItemProfile APS types:

{
   "apsVersion" : "2.0",
   "name" : "sampleItemProfile",
   "id" : "http://demo.example.com/app/test-vendor-product/profile/item/1.0",
   "implements" : [
      "http://aps-standard.org/types/core/profile/service/1.0",
      "http://aps-standard.org/types/core/profile/item/1.0"
   ],
   /* Other parts */
}

The two implemented APS types bring together the following resource properties:

  • profileName: a profile name inherited from the ServiceProfile APS type and assigned by the vendor or provider.

  • itemId: a vendor-specific resource ID inherited from the ItemProfile APS type and assigned by the vendor.

  • mpn: the product MPN inherited from the ItemProfile APS type and assigned by the vendor or provider.

For more details about the MPN use, refer to the Product Line Expansion example.