...

What status and exception codes are returned.
Returns HTTP/1.1 status code 201 if the request was successful.

Any other special return and/or exception codes.

REQUEST

PUT /catalogManagement/productOffering/42

Content-type: application/json

{
            "id": "42",
            "href": "http://serverlocation:port/catalogManagement/productOffering/42",
            "version": "2.0",
            "lastUpdate": "2013-04-19T16:42:23-04:00",
            "name": "Virtual Storage Medium",
            "description": "Virtual Storage Medium",
            "isBundle": "true",
            "lifecycleStatus": "Active",
            "validFor": {
                        "startDateTime": "2013-04-19T16:42:23-04:00",
                        "endDateTime": "2013-06-19T00:00:00-04:00"
            },
            "category": [
                        {

                                    "id": "12",
                                    "href": "http://serverlocation:port/catalogManagement/category/12",
                                    "version": "2.0",
                                    "name": "Cloud offerings"
                        }
            ],
            "channel": [
                        {

                                    "id": "13",
                                    "href": "http://serverlocation:port/marketSales/channel/13",
                                    "name": "Online Channel"
                        },
                        {

                                    "id": "14",
                                    "href": "http://serverlocation:port/marketSales/channel/14",
                                    "name": "Shop"
                        }
            ],
            "place": [
                        {
                                    "id": "12",
                                    "href": "http://serverlocation:port/marketSales/place/12",
                                    "name": "France"
                        },
                        {
                                    "id": "14",
                                    "href": "http://serverlocation:port/marketSales/place/14",
                                    "name": "Belgium"
                        }
            ],
            "bundledProductOffering": [
                        {

                                    "id": "15",
                                    "href": "http://serverlocation:port/catalogManagement/productOffering/15",
                                    "lifecycleStatus": "Active",
                                    "name": "Offering 15"
                        }, {

                                    "id": "64",
                                    "href": "http://serverlocation:port/catalogManagement/productOffering/64",
                                    "lifecycleStatus": "Active",
                                    "name": "Offering 64"
                        }
            ],
            "serviceLevelAgreement": {

                                    "id": "28",
                                    "href": "http://serverlocation:port/slaManagement/serviceLevelAgreement/28",
                                    "name": "Standard SLA"
            },
            "productSpecification": {

                                    "id": "13",
                                    "href": "http://serverlocation:port/catalogManagement/productSpecification/13",
                                    "version": "2.0",
                                    "name": "specification product 1"
                        },

"serviceCandidate": {

                                    "id": "13",
                                    "href": "http://serverlocation:port/catalogManagement/serviceCandidate/13",
                                    "version": "2.0",
                                    "name": "specification service 1"
                        },

"resourceCandidate": {

                                    "id": "13",
                                    "href": "http://serverlocation:port/catalogManagement/resourceCandidate/13",
                                    "version": "2.0",
                                    "name": "specification resource 1"
                        },

            "productOfferingTerm": [
                        {
                                    "name": "12 Month",
                                    "description": "12 month contract",
                                    "duration": "12",
                                    "validFor": {
                                                "startDateTime": "2013-04-19T16:42:23-04:00",
                                                "endDateTime": "2013-06-19T00:00:00-04:00"
                                    }
                        }
            ],
            "productOfferingPrice": [
                        {

                                    "name": "Monthly Price",
                                    "description": "monthlyprice",
                                    "validFor": {
                                                "startDateTime": "2013-04-19T16:42:23-04:00",
                                                "endDateTime": "2013-06-19T00:00:00-04:00"
                                    },
                                    "priceType": "recurring",
                                    "unitOfMeasure": "",
                                    "price": {
                                                "taxIncludedAmount": "12.00",
                                                "dutyFreeAmount": "10.00",
                                                "taxRate": "20.00",
                                                "currencyCode": "EUR"
                                    },
                                    "recurringChargePeriod": "monthly"
                        }, {

                                    "name": "Usage Price",
                                    "description": "usageprice",
                                    "validFor": {
                                                "startDateTime": "2013-04-19T16:42:23-04:00",
                                                "endDateTime": "2013-06-19T00:00:00-04:00"
                                    },
                                    "priceType": "usage",
                                    "unitOfMeasure": "second",
                                    "price": {
                                                "taxIncludedAmount": "12.00",
                                                "dutyFreeAmount": "10.00",
                                                "taxRate": "20.00",
                                                "currencyCode": "EUR"
                                    },
                                    "recurringChargePeriod": ""
                        }
            ]
}

RESPONSE

201

Content-Type: application/json

{
            "id": "42",
            "href": "http://serverlocation:port/catalogManagement/productOffering/42",
            "version": "3.0",
            "lastUpdate": "2013-06-05T08:30:45-04:00",
            "name": "Virtual Storage Medium",
            "description": "Virtual Storage Medium",
            "isBundle": "true",
            "lifecycleStatus": "Active",
            "validFor": {
                        "startDateTime": "2013-04-19T16:42:23-04:00",
                        "endDateTime": "2013-06-19T00:00:00-04:00"
            },
            "category": [
                        {

                                   "id": "12",
                                    "href": "http://serverlocation:port/catalogManagement/category/12",
                                    "version": "2.0",
                                    "name": "Cloud offerings"
                        }
            ],
            "channel": [
                        {

                                   "id": "13",
                                    "href": "http://serverlocation:port/marketSales/channel/13",
                                    "name": "Online Channel"
                        },
                        {

                                   "id": "14",
                                    "href": "http://serverlocation:port/marketSales/channel/14",
                                    "name": "Shop"
                        }
            ],
            "place": [
                        {

                                   "id": "12",
                                    "href": "http://serverlocation:port/marketSales/place/12",
                                    "name": "France"
                        },
                        {

                                   "id": "14",
                                    "href": "http://serverlocation:port/marketSales/place/14",
                                    "name": "Belgium"
                        }
            ],
            "bundledProductOffering": [
                        {

                                   "id": "15",
                                    "href": "http://serverlocation:port/catalogManagement/productOffering/15",
                                    "lifecycleStatus": "Active",
                                    "name": "Offering 15"
                        }, {

                                   "id": "64",
                                    "href": "http://serverlocation:port/catalogManagement/productOffering/64",
                                    "lifecycleStatus": "Active",
                                    "name": "Offering 64"
                        }
            ],
            "serviceLevelAgreement": {

                        "id": "28",
                        "href": "http://serverlocation:port/slaManagement/serviceLevelAgreement/28",
                        "name": "Standard SLA"
            },
            "productSpecification": {

                        "id": "13",
                        "href": "http://serverlocation:port/catalogManagement/productSpecification/13",
                        "version": "2.0",
                        "name": "specification product 1"
                        },

            "serviceCandidate": {
                        "id": "13",
                        "href": "http://serverlocation:port/catalogManagement/serviceCandidate/13",
                        "version": "2.0",
                        "name": "specification service 1"
                        },

"resourceCandidate": {

                        "id": "13",
                        "href": "http://serverlocation:port/catalogManagement/resourceCandidate/13",
                        "version": "2.0",
                        "name": "specification resource 1"
                        },

            "productOfferingTerm": [
                        {
                                    "name": "12 Month",
                                    "description": "12 month contract",
                                    "duration": "12",
                                    "validFor": {
                                                "startDateTime": "2013-04-19T16:42:23-04:00",
                                                "endDateTime": "2013-06-19T00:00:00-04:00"
                                    }
                        }
            ],
            "productOfferingPrice": [
                        {

                                    "name": "Monthly Price",
                                    "description": "monthlyprice",
                                    "validFor": {
                                                "startDateTime": "2013-04-19T16:42:23-04:00",
                                                "endDateTime": "2013-06-19T00:00:00-04:00"
                                    },
                                    "priceType": "recurring",
                                    "unitOfMeasure": "",
                                    "price": {
                                                "taxIncludedAmount": "12.00",
                                                "dutyFreeAmount": "10.00",
                                                "taxRate": "20.00",
                                                "currencyCode": "EUR"
                                    },
                                    "recurringChargePeriod": "monthly"
                        }, {

                                    "name": "Usage Price",
                                    "description": "usageprice",
                                    "validFor": {
                                                "startDateTime": "2013-04-19T16:42:23-04:00",
                                                "endDateTime": "2013-06-19T00:00:00-04:00"
                                    },
                                    "priceType": "usage",
                                    "unitOfMeasure": "second",
                                    "price": {
                                                "taxIncludedAmount": "12.00",
                                                "dutyFreeAmount": "10.00",
                                                "taxRate": "20.00",
                                                "currencyCode": "EUR"
                                    },
                                    "recurringChargePeriod": ""
                        }
            ]
}

Anchor
_Toc405197201
_Toc405197201
PUT /catalogManagement/productSpecification

Description :

This Uniform Contract operation is used to completely update the representation of a managed entity or a task.
Anchor_Toc405197201_Toc405197201PUT /catalogManagement/productSpecificationDescription :This operation completely updates a productSpecification.
The resource represents a managed entity.
The ID may be a string (or a string containing numbers).

...

What status and exception codes are returned.

Returns HTTP/1.1 status code 201 if the request was successful.

Any other special return and/or exception codes.

REQUEST

PUT /catalogManagement/productSpecification

Content-type:

application/json

{
            "id": "22",
            "href": "http://serverlocation:port/catalogManagement/productSpecification/22",
            "version": "2.0",             "lastUpdate": "2013-04-19T16:42:23-04:00",             "name": "iPhone 42",             "description": "Siri works on this iPhone",             "isBundle": "true",             "brand": "Apple",             "lifecycleStatus": "Launched",             "validFor": {
                        "startDateTime": "2013-06-20T16:42:23-04:00",                         "endDateTime": ""             },
            "relatedParty": [                         {

"id": "1234", "role": "Owner", "href": "http://serverLocation:port/partyManagement/partyRole/1234" } ], "attachment": [ {

"id": "22", "href": "http://serverlocation:port/documentManagement/attachment/22", "type": "Picture", "url": "http://xxxxx" }
], "bundledProductSpecification": [ {

"id": "15", "href": "http://serverlocation:port/catalogManagement/productSpecification/15", "lifecycleStatus": "Launched",
"name": "Product specification 15" }, {

"id": "64", "href": "http://serverlocation:port/catalogManagement/productSpecification/64", "lifecycleStatus": "Launched", "name": "Product specification 64" }
], "productSpecificationRelationship": [ { "type": "dependency",

"id": "23",
                                    "href": "http://serverlocation:port/catalogManagement/productSpecification/23",                              "validFor": {
                                    "startDateTime": "2013-04-19T16:42:23-04:00",                                     "endDateTime": ""                                     }                         }             ],
            "serviceSpecification": [                         {

                        "id": "13",                         "href": "http://serverlocation:port/catalogManagement/serviceSpecification/13",                         "name": "specification 1",                         "version": "1.1"                         }             ],
            "resourceSpecification": [                         {
                        "id": "13",                         "href": "http://serverlocation:port/catalogManagement/resourceSpecification/13",                         "name": "specification 1",                         "version": "1.1"                         }             ],             "productSpecCharacteristic": [                         {                                     "name": "Screen Size",                                     "description": "Screen size",                                     "valueType": "number",                                     "configurable": "false",                                     "validFor": {
                                                "startDateTime": "2013-04-19T16:42:23-04:00",                                                 "endDateTime": ""                                     },                                 "productSpecCharacteristicValue": [
                                                {                                                             "valueType": "number",                                                             "default": "true",                                                             "value": "4.2",                                                             "unitOfMeasure": "inches",                                                             "valueFrom": "",                                                             "valueTo": "",                                                             "validFor": {                                                                         "startDateTime": "2013-04-19T16:42:23-04:00",                                                                         "endDateTime": ""                                                             }                                                 }                                     ]                         }, {                                     "name": "Colour",                                     "description": "Colour",                                     "valueType": "string",                                     "configurable": "true",                                     "validFor": {                                                 "startDateTime": "2013-04-19T16:42:23-04:00",                                                 "endDateTime": ""                                     },
                                    "productSpecCharacteristicValue": [                                                 {
                                                            "valueType": "string",                                                             "default": "true",                                                             "value": "Black",                                                             "unitOfMeasure": "",                                                             "valueFrom": "",                                                             "valueTo": "",                                                             "validFor": {                                                                         "startDateTime": "2013-04-19T16:42:23-04:00",                                                                         "endDateTime": ""                                                             }                                                 }, {
                                                            "valueType": "string",                                                             "default": "false",                                                             "value": "White",                                                             "unitOfMeasure": "",                                                             "valueFrom": "",                                                             "valueTo": "",                                                             "validFor": {
                                                                        "startDateTime": "2013-04-19T16:42:23-04:00",                                                                         "endDateTime": ""                                                             }                                                 }                                     ]                         }             ] }

RESPONSE

201

Content-Type: application/json

{ "id": "22", "href": "http://serverlocation:port/catalogManagement/productSpecification/22", "version": "2.0", "lastUpdate": "2013-06-20T16:42:23-04:00", "name": "iPhone 42", "description": "Siri works on this iPhone", "isBundle": "true", "brand": "Apple", "lifecycleStatus": "Launched", "validFor": { "startDateTime": "2013-06-20T16:42:23-04:00", "endDateTime": "" }, "relatedParty": [ {

                        "id": "1234",                         "role": "Owner",                                     "href": "http://serverLocation:port/partyManagement/partyRole/1234"
                        }
            ],             "attachment": [                         {

"id": "22", "href": "http://serverlocation:port/documentManagement/attachment/22", "type": "Picture", "url": "http://xxxxx" } ], "bundledProductSpecification": [ {

                           "id": "15",                          "href": "http://serverlocation:port/catalogManagement/productSpecification/15",
                           "lifecycleStatus": "Launched",
                            "name": "Product specification 15"                         }, {

                                 "id": "64",                                "href": "http://serverlocation:port/catalogManagement/productSpecification/64",
                                 "lifecycleStatus": "Launched",
                                "name": "Product specification 64"
                        }
            ],
            "productSpecificationRelationship": [                         {
                            "type": "dependency",

                              "id": "23",                             "href": " "http://serverlocation:port/catalogManagement/productSpecification/23",                              "validFor": {
                                                "startDateTime": "2013-04-19T16:42:23-04:00",                                                 "endDateTime": ""                                     }
                        }
            ],             "serviceSpecification": [                         {

                                    "id": "13",                                     "href": "http://serverlocation:port/catalogManagement/serviceSpecification/13",
                                    "name": "specification 1",
                                    "version": "1.1"
                        }
            ],             "resourceSpecification": [
                        {

"id": "13"

,

                                    "href": "http://serverlocation:port/catalogManagement/resourceSpecification/13",                                     "name": "specification 1",                                     "version": "1.1"                         }             ],             "productSpecCharacteristic": [                         {
                                    "name": "Screen Size",                                     "description": "Screen size",                                     "valueType": "number",                                     "configurable": "false",                                     "validFor": {
                                                "startDateTime": "2013-04-19T16:42:23-04:00",                                                 "endDateTime": ""                                     },                                 "productSpecCharacteristicValue": [                                                 {                                                             "valueType": "number",                                                             "default": "true",                                                             "value": "4.2",                                                             "unitOfMeasure": "inches",                                                             "valueFrom": "",                                                             "valueTo": "",
                                                            "validFor": {                                                                         "startDateTime": "2013-04-19T16:42:23-04:00",                                                                         "endDateTime": ""                                                             }                                                 }                                     ]                         }, {                                     "name": "Colour",                                     "description": "Colour",                                     "valueType": "string",                                     "configurable": "true",                                     "validFor": {                                                 "startDateTime": "2013-04-19T16:42:23-04:00",                                                 "endDateTime": ""                                     },                                     "productSpecCharacteristicValue": [                                                 {
                                                            "valueType": "string",                                                             "default": "true",                                                             "value": "Black",                                                             "unitOfMeasure": "",                                                             "valueFrom": "",                                                             "valueTo": "",                                                             "validFor": {                                                                         "startDateTime": "2013-04-19T16:42:23-04:00",                                                                         "endDateTime": ""                                                             }                                                 }, {                                                             "valueType": "string",                                                             "default": "false",                                                             "value": "White",                                                             "unitOfMeasure": "",                                                             "valueFrom": "",                                                             "valueTo": "",                                                             "validFor": {                                                                         "startDateTime": "2013-04-19T16:42:23-04:00",                                                                         "endDateTime": ""                                                             }                                                 }                                     ]                         }             ] }

Anchor
_Toc405197202
_Toc405197202
PATCH /catalogManagement/category/{ID}

Anchor

	_Ref234978967
	_Ref234978967

Anchor

	_Toc235288517
	_Toc235288517

Anchor

	_Toc236554611
	_Toc236554611

Anchor

	_Toc236554912
	_Toc236554912

Anchor

	_Toc236555375
	_Toc236555375

Anchor

	_Toc225613455
	_Toc225613455

Anchor

	_Toc225603244
	_Toc225603244

Anchor

	_Ref226733430
	_Ref226733430

Anchor

	_Ref230885009
	_Ref230885009

Anchor

	_Ref231980155
	_Ref231980155

Anchor

	_Ref232940733
	_Ref232940733

Anchor

	_Ref232940829
	_Ref232940829

This Uniform Contract operation is used to partially update the representation of a managed entity or a task.
Description :

This operation partially updates a category.
The resource represents a managed entity.
The ID may be a string (or a string containing numbers).

...

Further document any rules that must be implemented when patching attributes.

Rule name	Rule/Pre Condition/Side Effects/Post Conditons
Root	When isRoot is patched to false, parentId should indicate the parent category. When isRoot is patched to true, parentId should be empty.

REQUEST

PATCH /catalogManagement/category/{42}
Content-type: application/json

{
"parentId": "",

"isRoot": "true"

}

RESPONSE

201

Content-Type: application/json

{
            "id": "42",
            "href": "http://serverlocation:port/catalogManagement/category/42",
            "lastUpdate": "2013-04-19T16:42:23-04:00",
            "version": "2.0",
            "lifecycleStatus": "Active",
            "validFor": {
                        "startDateTime": "2013-04-19T16:42:23-04:00",
                        "endDateTime": ""
            },
            "parentId": "",
            "isRoot": "true",
            "name": "Cloud Services",
            "description": "A category to hold all available cloud service offers"
}

Anchor
_Toc405197203
_Toc405197203
PATCH /catalogManagement/productOffering/{ID}

...

Rule name	Rule/Pre Condition/Side Effects/Post Conditons
isBundle	isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true). If false, then a productOffering will be returned, but the bundledProductOffering will be absent or empty and vice-versa if isBundle is true.

REQUEST

PATCH /catalogManagement/productOffering/{42}

Content-type: application/json-patch+json

{
            "op": "add",
            "path": "/place",
            "value": {
                        "id": "44",
                        "href": "http://serverlocation:port/marketSales/place/44",
                        "name": "Spain"
            }
}

RESPONSE

201

Content-Type: application/json

{
            "id": "42",
            "href": "http://serverlocation:port/catalogManagement/productOffering/42",
            "version": "2.0",
            "lastUpdate": "2013-06-19T16:42:23-04:00",
            "name": "Virtual Storage Medium",
            "description": "Virtual Storage Medium",
            "isBundle": "true",
            "lifecycleStatus": "Active",
            "validFor": {
                        "startDateTime": "2013-04-19T16:42:23-04:00",
                        "endDateTime": "2013-06-19T00:00:00-04:00"
            },
            "category": [
                        {
                                    "id": "12",
                                    "href": "http://serverlocation:port/catalogManagement/category/12",
                                    "version": "2.0",
                                    "name": "Cloud offerings"
                        }
            ],
            "channel": [
                        {
                                    "id": "13",
                                    "href": "http://serverlocation:port/marketSales/channel/13",
                                    "name": "Online Channel"
                        }
            ],
            "place": [
                        {
                                    "id": "12",
                                    "href": "http://serverlocation:port/marketSales/place/12",
                                    "name": "France"
                        },
                        {
                                    "id": "44",
                                    "href": "http://serverlocation:port/marketSales/place/44",
                                    "name": "Spain"           }

            ],
            "bundledProductOffering": [
                        {
                                    "id": "15",
                                    "href": "http://serverlocation:port/catalogManagement/productOffering/15",
                                    "lifecycleStatus": "Active",
                                    "name": "Offering 15"
                        }, {
                                    "id": "64",
                                    "href": "http://serverlocation:port/catalogManagement/productOffering/64",
                                    "lifecycleStatus": "Active",
                                    "name": "Offering 64"
                        }
            ],
            "serviceLevelAgreement": {
                        "id": "28",
                        "href": "http://serverlocation:port/slaManagement/serviceLevelAgreement/28",
                        "name": "Standard SLA"
            },
            "productSpecification": {
                                    "id": "13",
                                    "href": "http://serverlocation:port/catalogManagement/productSpecification/13",
                                    "version": "2.0",
                                    "name": "specification product 1"
                        },

            "serviceCandidate": {
                                    "id": "13",
                                    "href": "http://serverlocation:port/catalogManagement/serviceCandidate/13",
                                    "version": "2.0",
                                    "name": "specification service 1"
                        },

            "resourceCandidate": {
                                    "id": "13",
                                    "href": "http://serverlocation:port/catalogManagement/resourceCandidate/13",
                                    "version": "2.0",
                                    "name": "specification resource 1"
                        },

            "productOfferingTerm": [
                        {
                                    "name": "12 Month",
                                    "description": "12 month contract",
                                    "duration": "12",
                                    "validFor": {
                                                "startDateTime": "2013-04-19T16:42:23-04:00",
                                                "endDateTime": "2013-06-19T00:00:00-04:00"
                                    }
                        }
            ],
            "productOfferingPrice": [
                        {

                                    "name": "Monthly Price",
                                    "description": "monthlyprice",
                                    "validFor": {
                                                "startDateTime": "2013-04-19T16:42:23-04:00",
                                                "endDateTime": "2013-06-19T00:00:00-04:00"
                                    },
                                    "priceType": "recurring",
                                    "unitOfMeasure": "",
                                    "price": {
                                                "taxIncludedAmount": "12.00",
                                                "dutyFreeAmount": "10.00",
                                                "taxRate": "20.00",
                                                "currencyCode": "EUR"
                                    },
                                    "recurringChargePeriod": "monthly"
                        }, {

                                    "name": "Usage Price",
                                    "description": "usageprice",
                                    "validFor": {
                                                "startDateTime": "2013-04-19T16:42:23-04:00",
                                                "endDateTime": "2013-06-19T00:00:00-04:00"
                                    },
                                    "priceType": "usage",
                                    "unitOfMeasure": "second",
                                    "price": {
                                                "taxIncludedAmount": "12.00",
                                                "dutyFreeAmount": "10.00",
                                                "taxRate": "20.00",
                                                "currencyCode": "EUR"
                                    },
                                    "recurringChargePeriod": ""
                        }
            ]
}

Anchor
_Toc405197204
_Toc405197204
PATCH /catalogManagement/productSpecification/{ID}

...

Screen Size

REQUEST
PATCH /catalogManagement/productSpecification/{22} Content-type: application/json-patch+json { "op": "add", "path": "/attachment", "value": { "id": "44", "href": "http://serverlocation:port/documentManagement/attachment/44", "type": "Video", "url": "http://yyyyy" } }
RESPONSE
201 Content-Type: application/json { "id": "22", "href": "http://serverlocation:port/catalogManagement/productSpecification/22", "productNumber": "I54-340-KC", "version": "2.0", "lastUpdate": "2013-06-19T16:42:23-04:00", "name": "iPhone 42", "description": "Siri works on this iPhone", "isBundle": "true", "brand": "Apple", "lifecycleStatus": "Active", "validFor": { "startDateTime": "2013-04-19T16:42:23-04:00", "endDateTime": "2013-06-19T00:00:00-04:00" }, "relatedParty": [ { "id": "1234", "role": "Owner", "href": "http ://serverLocation:port/partyManagement/partyRole/1234" } ], "attachment": [ { "id": "22", "href": "http://serverlocation:port/documentManagement/attachment/22", "type": "Picture", "url": "http://xxxxx" }, { "href": "http://serverlocation:port/documentManagement/attachment/44", "type": "Video", "url": "http://yyyyy" } ], "bundledProductSpecification": [ { "id": "15", "href": "http://serverlocation:port/catalogManagement/productSpecification/15", "lifecycleStatus": "Active", "name": "Product specification 15" }, { "id": "64", "href": "http://serverlocation:port/catalogManagement/productSpecification/64", "lifecycleStatus": "Active", "name": "Product specification 64" } ], "productSpecificationRelationship": [ { "type": "dependency", "id": "23", "href": " http://serverlocation:port/catalogManagement/productSpecification/23", "validFor": { "startDateTime": "2013-04-19T16:42:23-04:00", "endDateTime": "" } } ], "serviceSpecification": [ { "id": "13", "href": "http://serverlocation:port/catalogManagement/serviceSpecification/13", "name": "specification 1", "version": "1.1" } ], "resourceSpecification": [ { "id": "13", "href": "http://serverlocation:port/catalogManagement/resourceSpecification/13", "name": "specification 1", "version": "1.1" } ], "productSpecCharacteristic": [ { "name": "	ScreenSize", "description": "Screen size", "valueType": "number", "configurable": "false", "validFor": { "startDateTime": "2013-04-19T16:42:23-04:00", "endDateTime": "" }, "productSpecCharacteristicValue": [ { "valueType": "number", "default": "true", "value": "4.2", "unitOfMeasure": "inches", "valueFrom": "", "valueTo": "", "validFor": { "startDateTime": "2013-04-19T16:42:23-04:00", "endDateTime": "" } } ] }, { "name": "Colour", "description": "Colour", "valueType": "string", "configurable": "true", "validFor": { "startDateTime": "2013-04-19T16:42:23-04:00", "endDateTime": "" }, "productSpecCharacteristicValue": [ { "valueType": "string", "default": "true", "value": "Black", "unitOfMeasure": "", "valueFrom": "", "valueTo": "", "validFor": { "startDateTime": "2013-04-19T16:42:23-04:00", "endDateTime": "" } }, { "valueType": "string", "default": "false", "value": "White", "unitOfMeasure": "", "valueFrom": "", "valueTo": "", "validFor": { "startDateTime": "2013-04-19T16:42:23-04:00", "endDateTime": "" } } ] } ] }

Anchor
_Toc405197205
_Toc405197205
POST /catalogManagement/category

...

Further specify any rules on the creation of the entity

Rule name	Rule

REQUEST

POST catalogManagement/category
Content-type: application/json
{
"version": "1.0",

"lifecycleStatus": "Active", "validFor": { "startDateTime": "2013-04-19T16:42:23-04:00", "endDateTime": "" }, "parentid": "http://serverlocation:port/catalogManagement/category/42",

"isRoot": "false",

"name": "Cloud Services", "description": "A category to hold all available cloud service offers"
}

RESPONSE

201
Content-Type: application/json
{

"id": "42", "href": "http://serverlocation:port/catalogManagement/category/42", "lastUpdate": "2013-04-19T16:42:23-04:00", "version": "1.0", "lifecycleStatus": "Active", "validFor": { "startDateTime": "2013-04-19T16:42:23-04:00", "endDateTime": "" }, "parentid": "http://serverlocation:port/catalogManagement/category/42",

"isRoot": "false",
"name": "Cloud Services", "description": "A category to hold all available cloud service offers"
}

Anchor
_Toc405197206
_Toc405197206
POST /catalogManagement/productOffering

This Uniform Contract operation is used to create a managed entity or a task.
Description :

This operation creates a productOffering
The resource represents a managed entity.
The ID may be a string (or a string containing numbers).

...

Further specify any rules on the creation of the entity

Rule name	Rule

REQUEST

POST catalogManagement/productOffering
Content-type: application/json

{

"version": "1.0",

            "name": "Virtual Storage Medium",
            "description": "Virtual Storage Medium",
            "isBundle": "true",
            "lifecycleStatus": "Active",
            "validFor": {
                        "startDateTime": "2013-04-19T16:42:23-04:00",
                        "endDateTime": "2013-06-19T00:00:00-04:00"
            },
            "category": [
                        {
                                    "id": "12",
                                    "href": "http://serverlocation:port/catalogManagement/category/12",
                                    "version": "2.0",
                                    "name": "Cloud offerings"
                        }
            ],
            "channel": [
                        {
                                    "id": "13",
                                    "href": "http://serverlocation:port/marketSales/channel/13",
                                    "name": "Online Channel"
                        }
            ],
            "place": [
                        {
                                    "id": "12",
                                    "href": "http://serverlocation:port/marketSales/place/12",
                                    "name": "France"
                        }
            ],
            "bundledProductOffering": [
                        {
                                    "id": "15",
                                    "href": "http://serverlocation:port/catalogManagement/productOffering/15",
                                    "lifecycleStatus": "Active",
                                    "name": "Offering 15"
                        }, {
                                    "id": "64",
                                    "href": "http://serverlocation:port/catalogManagement/productOffering/64",
                                    "lifecycleStatus": "Active",
                                    "name": "Offering 64"
                        }
            ],
            "serviceLevelAgreement": {
                        "id": "28",
                        "href": "http://serverlocation:port/slaManagement/serviceLevelAgreement/28",
                        "name": "Standard SLA"
            },
            "productSpecification": {
                                    "id": "13",
                                    "href": "http://serverlocation:port/catalogManagement/productSpecification/13",
                                    "version": "2.0",
                                    "name": "specification product 1"
                        },

            "serviceCandidate": {
                                    "id": "13",
                                    "href": "http://serverlocation:port/catalogManagement/serviceCandidate/13",
                                    "version": "2.0",
                                    "name": "specification service 1"
                        },

            "resourceCandidate": {
                                    "id": "13",
                                    "href": "http://serverlocation:port/catalogManagement/resourceCandidate/13",
                                    "version": "2.0",
                                    "name": "specification resource 1"
                        },

            "productOfferingTerm": [
                        {
                                    "name": "12 Month",
                                    "description": "12 month contract",
                                    "duration": "12",
                                    "validFor": {
                                                "startDateTime": "2013-04-19T16:42:23-04:00",
                                                "endDateTime": "2013-06-19T00:00:00-04:00"
                                    }
                        }
            ],
            "productOfferingPrice": [
                        {

                                    "name": "Monthly Price",
                                    "description": "monthlyprice",
                                    "validFor": {
                                                "startDateTime": "2013-04-19T16:42:23-04:00",
                                                "endDateTime": "2013-06-19T00:00:00-04:00"
                                    },
                                    "priceType": "recurring",
                                    "unitOfMeasure": "",
                                    "price": {
                                                "taxIncludedAmount": "12.00",
                                                "dutyFreeAmount": "10.00",
                                                "taxRate": "20.00",
                                                "currencyCode": "EUR"
                                    },
                                    "recurringChargePeriod": "monthly"
                        }, {

                                    "name": "Usage Price",
                                    "description": "usageprice",
                                    "validFor": {
                                                "startDateTime": "2013-04-19T16:42:23-04:00",
                                                "endDateTime": "2013-06-19T00:00:00-04:00"
                                    },
                                    "priceType": "usage",
                                    "unitOfMeasure": "second",
                                    "price": {
                                                "taxIncludedAmount": "12.00",
                                                "dutyFreeAmount": "10.00",
                                                "taxRate": "20.00",
                                                "currencyCode": "EUR"
                                    },
                                    "recurringChargePeriod": ""
                        }
            ]
}

RESPONSE

201
Content-Type: application/json

{
            "id": "42",
            "href": "http://serverlocation:port/catalogManagement/productOffering/42",
            "version": "1.0",
            "lastUpdate": "2013-04-19T16:42:23-04:00",
            "name": "Virtual Storage Medium",
            "description": "Virtual Storage Medium",
            "isBundle": "true",
            "lifecycleStatus": "Active",
            "validFor": {
                        "startDateTime": "2013-04-19T16:42:23-04:00",
                        "endDateTime": "2013-06-19T00:00:00-04:00"
            },
            "category": [
                        {
                                    "id": "12",
                                    "href": "http://serverlocation:port/catalogManagement/category/12",
                                    "version": "2.0",
                                    "name": "Cloud offerings"
                        }
            ],
            "channel": [
                        {
                                    "id": "13",
                                    "href": "http://serverlocation:port/marketSales/channel/13",
                                    "name": "Online Channel"
                        }
            ],
            "place": [
                        {
                                    "id": "12",
                                    "href": "http://serverlocation:port/marketSales/place/12",
                                    "name": "France"
                        }
            ],
            "bundledProductOffering": [
                        {
                                    "id": "15",
                                    "href": "http://serverlocation:port/catalogManagement/productOffering/15",
                                    "lifecycleStatus": "Active",
                                    "name": "Offering 15"
                        }, {
                                    "id": "64",
                                    "href": "http://serverlocation:port/catalogManagement/productOffering/64",
                                    "lifecycleStatus": "Active",
                                    "name": "Offering 64"
                        }
            ],
            "serviceLevelAgreement": {
                        "id": "28",
                        "href": "http://serverlocation:port/slaManagement/serviceLevelAgreement/28",
                        "name": "Standard SLA"
            },
            "productSpecification": {
                                    "id": "13",
                                    "href": "http://serverlocation:port/catalogManagement/productSpecification/13",
                                    "version": "2.0",
                                    "name": "specification product 1"
                        },

            "serviceCandidate": {
                                    "id": "13",
                                    "href": "http://serverlocation:port/catalogManagement/serviceCandidate/13",
                                    "version": "2.0",
                                    "name": "specification service 1"
                        },

            "resourceCandidate": {
                                    "id": "13",
                                    "href": "http://serverlocation:port/catalogManagement/resourceCandidate/13",
                                    "version": "2.0",
                                    "name": "specification resource 1"
                        },

            "productOfferingTerm": [
                        {
                                    "name": "12 Month",
                                    "description": "12 month contract",
                                    "duration": "12",
                                    "validFor": {
                                                "startDateTime": "2013-04-19T16:42:23-04:00",
                                                "endDateTime": "2013-06-19T00:00:00-04:00"
                                    }
                        }
            ],
            "productOfferingPrice": [
                        {

                                    "name": "Monthly Price",
                                    "description": "monthlyprice",
                                    "validFor": {
                                                "startDateTime": "2013-04-19T16:42:23-04:00",
                                                "endDateTime": "2013-06-19T00:00:00-04:00"
                                    },
                                    "priceType": "recurring",
                                    "unitOfMeasure": "",
                                    "price": {
                                                "taxIncludedAmount": "12.00",
                                                "dutyFreeAmount": "10.00",
                                                "taxRate": "20.00",
                                                "currencyCode": "EUR"
                                    },
                                    "recurringChargePeriod": "monthly"
                        }, {

                                    "name": "Usage Price",
                                    "description": "usageprice",
                                    "validFor": {
                                                "startDateTime": "2013-04-19T16:42:23-04:00",
                                                "endDateTime": "2013-06-19T00:00:00-04:00"
                                    },
                                    "priceType": "usage",
                                    "unitOfMeasure": "second",
                                    "price": {
                                                "taxIncludedAmount": "12.00",
                                                "dutyFreeAmount": "10.00",
                                                "taxRate": "20.00",
                                                "currencyCode": "EUR"
                                    },
                                    "recurringChargePeriod": ""
                        }
            ]
}

Anchor
_Toc405197207
_Toc405197207
POST /catalogManagement/productSpecification

This Uniform Contract operation is used to create a managed entity or a task.
Description :

This operation creates a productSpecification.
The resource represents a managed entity.
The ID may be a string (or a string containing numbers).

...

Further specify any rules on the creation of the entity

Rule name	Rule

REQUEST

POST catalogManagement/productSpecification
Content-type: application/json

{
"productNumber": "I42-340-DX",
"version": "2.0",
"lastUpdate": "2013-04-19T16:42:23.0Z",
"name": "iPhone 42",
"description": "Siri works on this iPhone",
"isBundle": true,
"brand": "Apple",
"lifecycleStatus": "Active",
"validFor":
{
"startDateTime": "2013-06-19T00:00:00.0Z",
"endDateTime": "2013-04-19T16:42:23.0Z"
},

"relatedParty":
[
{

"id": "1234",
"href": "http ://serverLocation:port/partyManagement/partyRole/1234",
"role": "Owner"
}
],

"attachment":
[
{

"id": "22",
"href": "http://serverlocation:port/documentManagement/attachment/22",
"type": "Picture",
"url": "http://xxxxx"
}
],

"bundledProductSpecification":
[
{
"id": "15",
"href": "http://serverlocation:port/productCatalogManagement/productSpecification/15",
"lifecycleStatus": "Active",
"name": "Product specification 15"
},

{

"id": "64",
"href": "http://serverlocation:port/productCatalogManagement/productSpecification/64",
"lifecycleStatus": "Active",
"name": "Product specification 64"
}
],

"productSpecificationRelationship":
[
{

"id": "23",
"href": "http://serverlocation:port/productCatalogManagement/productSpecification/23",
"type": "dependency",
"validFor":
{
"startDateTime": "2013-04-19T16:42:23.0Z"
}
}
],

"serviceSpecification":
[
{
"id": "13",
"href": "http://serverlocation:port/serviceCatalogManagement/serviceSpecification/13",
"name": "specification 13",
"version": "1.1"
}
],

"resourceSpecification":
[
{
"id": "13",
"href": "http://serverlocation:port/resourceCatalogManagement/resourceSpecification/13",
"name": "specification 13",
"version": "1.1"
}
],

"productSpecCharacteristic":
[
{
"name": "Screen Size",
"description": "Screen size",
"valueType": "number",
"configurable": false,
"ProductSpecCharacteristicValue":
[
{
"valueType": "number",
"default": true,
"value": "4.2",
"unitOfMeasure": "inches",
"valueFrom": "",
"valueTo": "",
"validFor":
{
"startDateTime": "2013-04-19T16:42:23.0Z"
}
}
],

"validFor":
{
"startDateTime": "2013-04-19T16:42:23.0Z"
}
},

{
"name": "Colour",
"description": "Colour",
"valueType": "string",
"configurable": true,
"ProductSpecCharacteristicValue":
[
{
"valueType": "string",
"default": true,
"value": "Black",
"unitOfMeasure": "",
"valueFrom": "",
"valueTo": "",
"validFor":
{
"startDateTime": "2013-04-19T16:42:23.0Z"
}
},

{
"valueType": "string",
"default": false,
"value": "White",
"unitOfMeasure": "",
"valueFrom": "",
"valueTo": "",
"validFor":
{
"startDateTime": "2013-04-19T16:42:23.0Z"
}
}
],

"validFor":
{
"startDateTime": "2013-04-19T16:42:23.0Z"
}
}
]
}

RESPONSE

201
Content-Type: application/json

{
"id": "22",
"href": "http://serverlocation:port/productCatalogManagement/productSpecification/22",
"productNumber": "I42-340-DX",
"version": "2.0",
"lastUpdate": "2013-04-19T16:42:23.0Z",
"name": "iPhone 42",
"description": "Siri works on this iPhone",
"isBundle": true,
"brand": "Apple",
"lifecycleStatus": "Active",
"validFor":
{
"startDateTime": "2013-06-19T00:00:00.0Z",
"endDateTime": "2013-04-19T16:42:23.0Z"
},

"relatedParty":
[
{

"id": "1234",
"href": "http ://serverLocation:port/partyManagement/partyRole/1234",
"role": "Owner"
}
],

"attachment":
[
{

"id": "22",
"href": "http://serverlocation:port/documentManagement/attachment/22",
"type": "Picture",
"url": "http://xxxxx"
}
],

"bundledProductSpecification":
[
{
"id": "15",
"href": "http://serverlocation:port/productCatalogManagement/productSpecification/15",
"lifecycleStatus": "Active",
"name": "Product specification 15"
},

{

"id": "64",
"href": "http://serverlocation:port/productCatalogManagement/productSpecification/64",
"lifecycleStatus": "Active",
"name": "Product specification 64"
}
],

"productSpecificationRelationship":
[
{

"id": "23",
"href": "http://serverlocation:port/productCatalogManagement/productSpecification/23",
"type": "dependency",
"validFor":
{
"startDateTime": "2013-04-19T16:42:23.0Z"
}
}
],

"serviceSpecification":
[
{
"id": "13",
"href": "http://serverlocation:port/serviceCatalogManagement/serviceSpecification/13",
"name": "specification 13",
"version": "1.1"
}
],

"resourceSpecification":
[
{
"id": "13",
"href": "http://serverlocation:port/resourceCatalogManagement/resourceSpecification/13",
"name": "specification 13",
"version": "1.1"
}
],

"productSpecCharacteristic":
[
{
"name": "Screen Size",
"description": "Screen size",
"valueType": "number",
"configurable": false,
"ProductSpecCharacteristicValue":
[
{
"valueType": "number",
"default": true,
"value": "4.2",
"unitOfMeasure": "inches",
"valueFrom": "",
"valueTo": "",
"validFor":
{
"startDateTime": "2013-04-19T16:42:23.0Z"
}
}
],

"validFor":
{
"startDateTime": "2013-04-19T16:42:23.0Z"
}
},

{
"name": "Colour",
"description": "Colour",
"valueType": "string",
"configurable": true,
"ProductSpecCharacteristicValue":
[
{
"valueType": "string",
"default": true,
"value": "Black",
"unitOfMeasure": "",
"valueFrom": "",
"valueTo": "",
"validFor":
{
"startDateTime": "2013-04-19T16:42:23.0Z"
}
},

{
"valueType": "string",
"default": false,
"value": "White",
"unitOfMeasure": "",
"valueFrom": "",
"valueTo": "",
"validFor":
{
"startDateTime": "2013-04-19T16:42:23.0Z"
}
}
],

"validFor":
{
"startDateTime": "2013-04-19T16:42:23.0Z"
}
}
]
}

Anchor
_Toc277486389
_Toc277486389
Anchor
_Toc405197208
_Toc405197208
POST catalogManagement/importJob

ImportJob Tasks are created as resources.
The ImportJob is attached to the URL of the root resource where the content of the file specified by the ImportJob will be applied.
For example to apply the content of the import file located at ftp://ftp.myCatalog.com/catalog.json to the catalogManagement root.

REQUEST

POST ../partyManagement/importJob
Content-type: application/json

{
"url": "ftp://ftp.myCatalog.com/catalog.json"
}

RESPONSE

201
Content-Type: application/json
Location: ../partyManagement/importJob/554
{

        "id": "54",         "href": "http:/api/catalogManagement/importJob/54",         "status": "running",         "path": "catalogManagement/",         "content-type": "application/json",
        "errorLog": "",         "creationDate": "2013-04-19T16:42:23-04:00",
        "url": "ftp://ftp.myCatalog.com/catalog.json"

}

Anchor
_Toc277486390
_Toc277486390
Anchor
_Toc405197209
_Toc405197209
POST catalogManagement/exportJob

ExportJob Tasks are created as resources.
The ExportJob is attached to a specific resource acting as the root for the collection of resources to be streamed to a File.
An ExportJob can be attached to a specific Resource in the Catalog Management application for example:

../catalogManagement/exportJob

...

REQUEST

POST ../catalogManagement/exportJob
Content-type: application/json

{
}

RESPONSE

201
Content-Type: application/json
Location: ../catalogManagement/exportJob/54

{
"id": "54", "href": "http:/api/catalogManagement/exportJob/54", "status": "running", "path": "catalogManagement", "content-type": "application/json", "errorLog": "", "creationDate": "2013-04-19T16:42:23-04:00", "completionDate": "", "url": "ftp://ftp.catalogManagement.com/catalog/54" }

Anchor
_Toc277486391
_Toc277486391
Anchor
_Toc405197210
_Toc405197210
GET catalogManagement/exportJob

...

REQUEST

GET ../catalogManagement/exportJob/54
Content-type: application/json

{
}

RESPONSE

200
Content-Type: application/json

{
"id": "54", "href": "http:/api/catalogManagement/exportJob/54", "status": "running", "path": "catalogManagement/", "content-type": "application/json", "errorLog": "", "creationDate": "2013-04-19T16:42:23-04:00", "completionDate": "2013-04-21T16:42:23-04:00", "url": "ftp://ftp.catalogManagement.com/catalog/54"
}

Anchor
_Toc277486392
_Toc277486392
Anchor
_Toc405197211
_Toc405197211
GET catalogManagement/importJob

...

REQUEST

GET ../catalogManagement/importJob/54
Content-type: application/json
{
}

RESPONSE

200
Content-Type: application/json

{         "id": "54",         "href": "http:/api/catalogManagement/importJob/54",         "status": "running",         "path": "catalogManagement",         "content-type": "application/json",         "errorLog": "",         "creationDate": "2013-04-19T16:42:23-04:00",         "completionDate": "2013-04-21T16:42:23-04:00",
        "url": "ftp://ftp.myCatalog.com/catalog.json"
    }

Anchor
_Toc405197212
_Toc405197212
DELETE API/{RESOURCE}/{ID}

...

What status and exception codes are returned.
Returns HTTP/1.1 status code 200 if the request was successful.

This Uniform Contract operation is used to completely update the representation of a managed entity or a task.

Space shortcuts

Page tree

Versions Compared

Old Version 4

New Version 5

Key

Anchor
_Toc405197201
_Toc405197201
PUT /catalogManagement/productSpecification

Anchor
_Toc405197202
_Toc405197202
PATCH /catalogManagement/category/{ID}

Anchor
_Toc405197203
_Toc405197203
PATCH /catalogManagement/productOffering/{ID}

Anchor
_Toc405197204
_Toc405197204
PATCH /catalogManagement/productSpecification/{ID}

Anchor
_Toc405197205
_Toc405197205
POST /catalogManagement/category

Anchor
_Toc405197206
_Toc405197206
POST /catalogManagement/productOffering

Anchor
_Toc405197207
_Toc405197207
POST /catalogManagement/productSpecification

Anchor
_Toc277486389
_Toc277486389
Anchor
_Toc405197208
_Toc405197208
POST catalogManagement/importJob

Anchor
_Toc277486390
_Toc277486390
Anchor
_Toc405197209
_Toc405197209
POST catalogManagement/exportJob

Anchor
_Toc277486391
_Toc277486391
Anchor
_Toc405197210
_Toc405197210
GET catalogManagement/exportJob

Anchor
_Toc277486392
_Toc277486392
Anchor
_Toc405197211
_Toc405197211
GET catalogManagement/importJob

Anchor
_Toc405197212
_Toc405197212
DELETE API/{RESOURCE}/{ID}

This Uniform Contract operation is used to completely update the representation of a managed entity or a task.

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 4

New Version 5

Key

Anchor_Toc405197201_Toc405197201PUT /catalogManagement/productSpecification

Anchor_Toc405197202_Toc405197202PATCH /catalogManagement/category/{ID}

Anchor_Toc405197203_Toc405197203PATCH /catalogManagement/productOffering/{ID}

Anchor_Toc405197204_Toc405197204PATCH /catalogManagement/productSpecification/{ID}

Anchor_Toc405197205_Toc405197205POST /catalogManagement/category

Anchor_Toc405197206_Toc405197206POST /catalogManagement/productOffering

Anchor_Toc405197207_Toc405197207POST /catalogManagement/productSpecification

Anchor_Toc277486389_Toc277486389 Anchor_Toc405197208_Toc405197208POST catalogManagement/importJob

Anchor_Toc277486390_Toc277486390 Anchor_Toc405197209_Toc405197209POST catalogManagement/exportJob

Anchor_Toc277486391_Toc277486391 Anchor_Toc405197210_Toc405197210GET catalogManagement/exportJob

Anchor_Toc277486392_Toc277486392 Anchor_Toc405197211_Toc405197211GET catalogManagement/importJob

Anchor_Toc405197212_Toc405197212DELETE API/{RESOURCE}/{ID}

This Uniform Contract operation is used to completely update the representation of a managed entity or a task.

Anchor
_Toc405197201
_Toc405197201
PUT /catalogManagement/productSpecification

Anchor
_Toc405197202
_Toc405197202
PATCH /catalogManagement/category/{ID}

Anchor
_Toc405197203
_Toc405197203
PATCH /catalogManagement/productOffering/{ID}

Anchor
_Toc405197204
_Toc405197204
PATCH /catalogManagement/productSpecification/{ID}

Anchor
_Toc405197205
_Toc405197205
POST /catalogManagement/category

Anchor
_Toc405197206
_Toc405197206
POST /catalogManagement/productOffering

Anchor
_Toc405197207
_Toc405197207
POST /catalogManagement/productSpecification

Anchor
_Toc277486389
_Toc277486389
Anchor
_Toc405197208
_Toc405197208
POST catalogManagement/importJob

Anchor
_Toc277486390
_Toc277486390
Anchor
_Toc405197209
_Toc405197209
POST catalogManagement/exportJob

Anchor
_Toc277486391
_Toc277486391
Anchor
_Toc405197210
_Toc405197210
GET catalogManagement/exportJob

Anchor
_Toc277486392
_Toc277486392
Anchor
_Toc405197211
_Toc405197211
GET catalogManagement/importJob

Anchor
_Toc405197212
_Toc405197212
DELETE API/{RESOURCE}/{ID}