General Information
| Service | API | Method |
|---|---|---|
| multitenant | /product/package | PUT |
Data Model:
Workflow:
Input
Type: application/json
Name | Source | Mandatory | Type | Special Format | Description |
|---|---|---|---|---|---|
| id | Query | YES | String | N/A | The product id |
| code | Query | YES | String | The Length is 4 - 5 | The product code |
| name | Body | YES | String | The product name | |
| description | Body | NO | String | The product description | |
| _TTL | Body | YES | String | '6', '12', '24', '48', '72', '96', '120', '144', '168' | |
| acl | Body | NO | Object | Product ACL |
Output
Valid Response
Valid Response Sample
{
}
Invalid Response
Error Response Sample
{
"result":false,
"errors":{
"codes":[460],
"details":[
{
"code":460,
"message":"Unable to find products"
}
]
}
}
Error Codes
Code | Description |
|---|---|
461 | Unable to find package |
437 | Unable to get the environment records |
460 | Unable to find products |
467 | Package already exists |
473 | Missing required fields |
476 | Unable to update product record |
500 | This record is locked. You cannot modify or delete it |
Example (CURL)
Request
Calling List Products API
> CURL -X PUT http://127.0.0.1:4004/product?id=%product_id% -d {
"code": "UPDATE",
"name": "Some Update",
"description": "package updated description",
"_TTL": "12",
"acl": {}
}
Response
List Products API response
{
"result": true,
"data": [
{
}
]
}
Add Comment