Views API for Specific API Key

POST 
/pim/manage/views/:apikey

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

This API provides functionality for managing and assigning Views to specific API Keys. With these endpoints, you can assign, edit, set a default View, or remove a previously assigned View from an API Key.

To utilize this API, send a POST request with a JSON body. Set the action key in the JSON body to one of the following values:

• listViews: Get a list of all Views assigned to an ApiKey
• addView: Assigning a View to an ApiKey.

The name of the View passed to the API must exist in the PIM's view Dictionary (to create a Vew in the Dictionary, see the "PIM View Dictionary" documentation section)

• editView: Allows you to edit the data that was used for assigning the view.
• setDefault: Change the default View in use
• deleteView: Removed a previously assigned View from an ApiKey.

Use Example Value and Schema for Json requests

Request

Responses

200

success

default

If there is an error with the API request, additional information will be provided in the response body.

Examples of error messages include:

• addView:

"status_message": "View is unknown! Please add it to Views Dictionary first!"

"status_message": "View with the same name already exist!"

"status_message": "Access denied!"

• editView, deleteView:

"status_message": "View does not exist"

• deleteView:

"status_message": "You can not delete 'Default' view Please set different view as 'Default' then try again."