Jump to

• Request
• Response
• Examples

Lock a product group for editing

post

/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/action/lockProductGroup

The action locks a product group for editing, and sends the product group identifier in request body.

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• productGroupId: number

{
    "type":"object",
    "properties":{
        "productGroupId":{
            "type":"number",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  Locks all product groups

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Locks all product groups"
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

The action locks a product group for editing, and sends the product group identifier in request body.

The following example shows how to lock a product group by submitting a POST request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X POST https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/action/lockProductGroup

Example of Request Body

The following shows an example of the request body in JSON format.

{
	"productGroupId" : 100000011628047
	
}

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "result": "Success"
}

Note:

When firing an operation on a product group, please wait for the response before performing another operation on the same product group.

For example, if you invoke REST call to lock product group 'A' ; then wait for the response of this operation before performing the next operation on that same product group .

Back to Top