PIMS Buckets Management API

POST 
/pim/manage/buckets

• Requires Data Editor ApiKey permissions.
• Example URI: https://instancename.piminto.com/api/en-us/pim/manage/buckets

The buckets API is designed to simplify the organization and management of assets within PIMS. It allows listing assets in a specific bucket, fetching trees of public and private buckets, creating new buckets, and deleting existing ones. Additionally, assets can be efficiently organized by placing them into specific buckets, providing a structured way to manage and categorize digital resources.

To use this API, send a POST request body JSON. ✔The description of JSON keys is provided in the Example Value and Schema.

Set the action key in the JSON body to one of the following values:

• listAssetsInBucket: List Assets in a Bucket.Method for listing assets in a specified bucket, providing convenience for organizing assets.

• moveAssetToBucket: Move Asset to Bucket. Method for initially placing an asset in a bucket or relocating it to a different bucket.

• getPublicBucketsTree: Get Public Buckets Tree. Method for obtaining a tree of public buckets that can be viewed and modified by everyone.

• getMyBucketsTree: Get My Buckets Tree.Method for obtaining a tree of private buckets owned by a specific owner (ApiUser or ApiKey).

• addBucket: Add New Bucket.Method for creating a new bucket with specified characteristics (type, name, parent bucket, order).✔The type parameter can be either "global" or "personal."

• editBucket: Edit Bucket Metadata.Method for editing bucket metadata, such as parent bucket, name, and order.

• deleteBucket: Delete Bucket.Method for deleting a bucket. All assets are moved to the parent bucket, and only the owner of the bucket or if the bucket is public can perform this operation.

Request

application/json

Body

required

oneOf
List Assets in a Bucket
action stringrequired
Possible values: [listAssetsInBucket]
bucket_id integerrequired
Move Asset to Bucket
action stringrequired
Possible values: [moveAssetToBucket]
asset_code stringrequired
bucket_id integerrequired
Get Public Buckets Tree
action stringrequired
Possible values: [getPublicBucketsTree]
Get My Buckets Tree
action stringrequired
Possible values: [getMyBucketsTree]
Add New Bucket
action stringrequired
Possible values: [addBucket]
type stringrequired
Possible values: [global, personal]
data objectrequired
parent_id integerrequired
name stringrequired
order integerrequired
Edit Bucket Metadata
action stringrequired
Possible values: [editBucket]
id integerrequired
data objectrequired
parent_id integerrequired
name stringrequired
order integerrequired
Delete Bucket
action stringrequired
Possible values: [deleteBucket]
bucket_id integerrequired

Responses

200

success

application/json

Schema

Schema

oneOf
List Assets in a Bucket
status stringrequired
assets object[]required
Array [
data objectrequired
Metadata. Extendable.
url string
filename string
type string
tags string[]
keywords string[]
description string
size string
asset stringrequired
]
Move Asset to Bucket
status stringrequired
asset_code stringrequired
bucket_id integerrequired
Get Public/My Buckets Tree
data objectrequired
publicBucketsTree object[]required
Array [
buc_path stringrequired
buc_parent_id integerrequired
buc_order integerrequired
buc_path_id stringrequired
children object[]required
Array [
buc_parent_id integerrequired
buc_path stringrequired
children undefined[]
buc_order integerrequired
buc_path_id stringrequired
buc_name stringrequired
id integerrequired
]
id integerrequired
buc_name stringrequired
]
status stringrequired
Add/Edit Bucket
status stringrequired
data objectrequired
parent_id integerrequired
name stringrequired
order integerrequired
Delete Bucket
status stringrequired

Example (from schema)

{}

List Assets in a Bucket

{
  "status": "OK",
  "assets": [
    {
      "data": {
        "url": "https://instancename.piminto.com/api/a/fe34e84xxxxxxxxxxxxxxxxxxxxxxxxx/image.png",
        "filename": "image.png",
        "type": "image",
        "tags": [
          "tag1",
          "tag2",
          "tag3"
        ],
        "keywords": [
          "keyword1",
          "keyword2",
          "keyword3"
        ],
        "description": "A generic assets description with some key features",
        "size": "3224"
      },
      "asset": "fe34e84xxxxxxxxxxxxxxxxxxxxxxxxx"
    }
  ]
}

Move Asset to Bucket

{
  "status": "OK",
  "asset_code": "fe34e84xxxxxxxxxxxxxxxxxxxxxxxxx",
  "bucket_id": "1000"
}

Get Public/My Buckets Tree

{
  "data": {
    "publicBucketsTree": [
      {
        "buc_path": "Bucket-1 Name",
        "buc_parent_id": 0,
        "buc_order": 0,
        "buc_path_id": "1",
        "children": [
          {
            "buc_parent_id": 1,
            "buc_path": "Bucket-1 Name > Bucket-2 Name",
            "children": [],
            "buc_order": 1,
            "buc_path_id": "1 > 2",
            "buc_name": "Bucket-2 Name",
            "id": 2
          }
        ],
        "id": 1,
        "buc_name": "Bucket-1 Name"
      }
    ]
  },
  "status": "OK"
}

Add/Edit Bucket

{
  "status": "OK",
  "data": {
    "parent_id": 1000,
    "name": "NameMyBucket",
    "order": 0
  }
}

Delete Bucket

{
  "status": "OK"
}

default

The reason for the error is included in the response body

application/json

Schema

Schema

status stringrequired

Possible values: [Error]

The status of the API request. A value of "Error" indicates that the request was not successfully sent or processed.

status_message stringrequired

Provides a message that describes the reason for the error that occurred while processing the API request.

Example (from schema)

{
  "status": "Error",
  "status_message": "string"
}

Loading...