Edit Product

This operation sets the Product status back to Edit. The operation is available for a Product in the following statuses:

  • Test

  • Review

  • Approved

  • Queued

Resource Representation

The edit link determines whether Product status can change to Edit.

The following is a resource representation for a Product with an updatable status:

{
  ... Product properties ...
  "links": [
    {
      "href": "http://[hostName]:[portNumber]/[api-context-root]/generic/products/{id}",
      "rel": "self"
    },
    {
      "href": "http://[hostName]:[portNumber]/[api-context-root]/products/{id}/edit",
      "rel": "product:edit",
      "httpMethod": "PUT"
    }
  ]
}

The following is a resource representation for a Product where the Product status cannot change to Edit. For example, where the Product is already in Edit status:

{
  ... Product properties ...
  "links": [
    {
      "href": "http://[hostName]:[portNumber]/[api-context-root]/generic/products/{id}",
      "rel": "self"
    }
  ]
}

Response Messages

Following are the messages the operation returns:

Success

A successful operation returns an HTTP 200 OK response.

Failure

If an error occurs, the operation returns an appropriate HTTP status code and a notification with the error details. See Response Messages for more details on error codes.

Here is the notification that appears when the operation encounters an error:

Table 1. Failure
Code Severity Text

PRD-HTTP-003

Fatal

To change the product status back to edit, the product must be in status Queued, Review, Test or Approved.

Authorization

The products.edit IP access restriction protects this operation.