Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

General Information

...

ServiceAPIMethodData ModelWorkflow
multitenant/product/purgePUTProductsN/A

Description

This API purges the ACL and all packages of a product that has an id that matches the one sent in query.

Input

...

Type: application/json


Name
Source
Mandatory
Type
Special Format
Description
idQueryYESStringN/AThe product id


Output

...

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response 

Valid Response

Code Block
languagejs
titleValid Response Sample
{ "result": true, "data": true }

Invalid Response

Code Block
languagejs
titleError Response Sample
{
    "result":false,
    "errors":{
        "codes":[460],
        "details":[
            {
                "code":460,
                "message":"Unable to find products"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes



Code
Description
400

Business logic required data are missing

460

Unable to find products

602

Model error: + %model_error%